Class ConfigurationBuilderResultCreatedEvent
java.lang.Object
java.util.EventObject
org.apache.commons.configuration2.event.Event
org.apache.commons.configuration2.builder.ConfigurationBuilderEvent
org.apache.commons.configuration2.builder.ConfigurationBuilderResultCreatedEvent
- All Implemented Interfaces:
Serializable
A specialized event class which is generated by a ConfigurationBuilder when a result configuration has been
created.
Events of this type are fired in the getConfiguration() method of a configuration builder each time a new
result object is created. At the time the event is fired, no lock is held. The newly created
ImmutableConfiguration object is available as a property of this event.
A use case for this event is to perform special initializations on newly created configuration objects. It is also an indication that a builder is now fully initialized; i.e. the managed configuration is available.
- Since:
- 2.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final EventType<ConfigurationBuilderResultCreatedEvent> The specialized event type for a newly created result configuration.Fields inherited from class org.apache.commons.configuration2.builder.ConfigurationBuilderEvent
ANY, CONFIGURATION_REQUEST, RESETFields inherited from class java.util.EventObject
source -
Constructor Summary
ConstructorsConstructorDescriptionConfigurationBuilderResultCreatedEvent(ConfigurationBuilder<?> source, EventType<? extends ConfigurationBuilderResultCreatedEvent> evType, ImmutableConfiguration createdConfiguration) Creates a new instance ofConfigurationBuilderResultCreatedEventand initializes its properties. -
Method Summary
Modifier and TypeMethodDescriptionGets the newly createdImmutableConfigurationobject.Methods inherited from class org.apache.commons.configuration2.builder.ConfigurationBuilderEvent
getSourceMethods inherited from class org.apache.commons.configuration2.event.Event
appendPropertyRepresentation, getEventType, toString
-
Field Details
-
RESULT_CREATED
The specialized event type for a newly created result configuration. Events of this type are generated by a configuration builder when a result configuration has been created.
-
-
Constructor Details
-
ConfigurationBuilderResultCreatedEvent
public ConfigurationBuilderResultCreatedEvent(ConfigurationBuilder<?> source, EventType<? extends ConfigurationBuilderResultCreatedEvent> evType, ImmutableConfiguration createdConfiguration) Creates a new instance ofConfigurationBuilderResultCreatedEventand initializes its properties.- Parameters:
source- theConfigurationBuilderobject which triggered this event (must not be null)evType- the type of this event (must not be null)createdConfiguration- the newly createdImmutableConfigurationobject (must not be null)- Throws:
IllegalArgumentException- if a required parameter is null
-
-
Method Details
-
getConfiguration
Gets the newly createdImmutableConfigurationobject.- Returns:
- the newly created
ImmutableConfiguration
-