Package | Description |
---|---|
org.apache.commons.configuration2 |
The Configuration main package.
|
org.apache.commons.configuration2.builder |
This package contains the implementations of configuration builder
classes used to create new
Configuration objects. |
org.apache.commons.configuration2.builder.combined |
A package containing the implementation of the builder for combined
configurations.
|
org.apache.commons.configuration2.event |
This package contains interfaces and classes for receiving notifications
about changes at configurations.
|
org.apache.commons.configuration2.reloading |
This package contains classes and interfaces related to the reloading mechanism.
|
Modifier and Type | Field and Description |
---|---|
static EventType<ConfigurationEvent> |
CombinedConfiguration.COMBINED_INVALIDATE
Constant for the event type fired when the internal node structure of a
combined configuration becomes invalid.
|
Modifier and Type | Method and Description |
---|---|
<T extends Event> |
PatternSubtreeConfigurationWrapper.addEventListener(EventType<T> eventType,
EventListener<? super T> listener) |
<T extends Event> |
DynamicCombinedConfiguration.addEventListener(EventType<T> eventType,
EventListener<? super T> listener) |
<T extends Event> |
PatternSubtreeConfigurationWrapper.getEventListeners(EventType<T> eventType) |
<T extends Event> |
PatternSubtreeConfigurationWrapper.removeEventListener(EventType<T> eventType,
EventListener<? super T> listener) |
<T extends Event> |
DynamicCombinedConfiguration.removeEventListener(EventType<T> eventType,
EventListener<? super T> listener) |
Modifier and Type | Field and Description |
---|---|
static EventType<ConfigurationBuilderEvent> |
ConfigurationBuilderEvent.ANY
The common super type for all events related to configuration builders.
|
static EventType<ConfigurationBuilderEvent> |
ConfigurationBuilderEvent.CONFIGURATION_REQUEST
The specific event type for configuration request events.
|
static EventType<ConfigurationBuilderEvent> |
ConfigurationBuilderEvent.RESET
The specific event type for builder reset events.
|
static EventType<ConfigurationBuilderResultCreatedEvent> |
ConfigurationBuilderResultCreatedEvent.RESULT_CREATED
The specialized event type for a newly created result configuration.
|
Modifier and Type | Method and Description |
---|---|
<E extends Event> |
BasicConfigurationBuilder.addEventListener(EventType<E> eventType,
EventListener<? super E> listener)
Adds an event listener for the specified event type.
|
<T extends Event> |
EventListenerParameters.addEventListener(EventType<T> eventType,
EventListener<? super T> listener)
Adds an event listener of the specified event type to this object.
|
protected <E extends Event> |
BasicConfigurationBuilder.installEventListener(EventType<E> eventType,
EventListener<? super E> listener)
Adds the specified event listener to this object.
|
<E extends Event> |
BasicConfigurationBuilder.removeEventListener(EventType<E> eventType,
EventListener<? super E> listener)
Removes the event listener registration for the given event type and
listener.
|
Constructor and Description |
---|
ConfigurationBuilderEvent(ConfigurationBuilder<?> source,
EventType<? extends ConfigurationBuilderEvent> evType)
Creates a new instance of
ConfigurationBuilderEvent and sets
basic properties. |
ConfigurationBuilderResultCreatedEvent(ConfigurationBuilder<?> source,
EventType<? extends ConfigurationBuilderResultCreatedEvent> evType,
ImmutableConfiguration createdConfiguration)
Creates a new instance of
ConfigurationBuilderResultCreatedEvent
and initializes its properties. |
Modifier and Type | Method and Description |
---|---|
<E extends Event> |
MultiFileConfigurationBuilder.addEventListener(EventType<E> eventType,
EventListener<? super E> l)
Adds an event listener for the specified event type.
|
<E extends Event> |
MultiFileConfigurationBuilder.removeEventListener(EventType<E> eventType,
EventListener<? super E> l)
Removes the event listener registration for the given event type and
listener.
|
Modifier and Type | Field and Description |
---|---|
static EventType<ConfigurationEvent> |
ConfigurationEvent.ADD_NODES
Constant for the event type for an add nodes operation.
|
static EventType<ConfigurationEvent> |
ConfigurationEvent.ADD_PROPERTY
Constant for the event type for an add property operation.
|
static EventType<Event> |
Event.ANY
The root event type for all configuration-related events.
|
static EventType<ConfigurationErrorEvent> |
ConfigurationErrorEvent.ANY
Constant for the common event type for all error events.
|
static EventType<ConfigurationEvent> |
ConfigurationEvent.ANY
Constant for the common super type of all configuration update events.
|
static EventType<ConfigurationEvent> |
ConfigurationEvent.ANY_HIERARCHICAL
Constant for the common base event type for all hierarchical update
events.
|
static EventType<ConfigurationEvent> |
ConfigurationEvent.CLEAR
Constant for the event type for a clear operation.
|
static EventType<ConfigurationEvent> |
ConfigurationEvent.CLEAR_PROPERTY
Constant for the event type for a clear property operation.
|
static EventType<ConfigurationEvent> |
ConfigurationEvent.CLEAR_TREE
Constant for the event type for a clear tree operation.
|
static EventType<ConfigurationErrorEvent> |
ConfigurationErrorEvent.READ
Constant for the event type indicating a read error.
|
static EventType<ConfigurationEvent> |
ConfigurationEvent.SET_PROPERTY
Constant for the event type for a set property operation.
|
static EventType<ConfigurationEvent> |
ConfigurationEvent.SUBNODE_CHANGED
Constant for the event type indicating a change on a sub configuration.
|
static EventType<ConfigurationErrorEvent> |
ConfigurationErrorEvent.WRITE
Constant for the event type indicating a write error.
|
Modifier and Type | Method and Description |
---|---|
EventType<?> |
ConfigurationErrorEvent.getErrorOperationType()
Returns the
EventType of the operation which caused this error. |
EventType<T> |
EventListenerRegistrationData.getEventType()
Returns the event type for this listener registration.
|
EventType<? extends Event> |
Event.getEventType()
Returns the type of this event.
|
EventType<? super T> |
EventType.getSuperType()
Returns the super event type.
|
Modifier and Type | Method and Description |
---|---|
static Set<EventType<?>> |
EventType.fetchSuperEventTypes(EventType<?> eventType)
Returns a set with all event types that are super types of the specified
type.
|
Modifier and Type | Method and Description |
---|---|
<T extends Event> |
BaseEventSource.addEventListener(EventType<T> eventType,
EventListener<? super T> listener) |
<T extends Event> |
EventSource.addEventListener(EventType<T> eventType,
EventListener<? super T> listener)
Adds an event listener for the specified event type.
|
<T extends Event> |
EventListenerList.addEventListener(EventType<T> type,
EventListener<? super T> listener)
Adds an event listener for the specified event type.
|
protected ConfigurationErrorEvent |
BaseEventSource.createErrorEvent(EventType<? extends ConfigurationErrorEvent> type,
EventType<?> opType,
String propName,
Object propValue,
Throwable ex)
Creates a
ConfigurationErrorEvent object based on the passed in
parameters. |
protected ConfigurationErrorEvent |
BaseEventSource.createErrorEvent(EventType<? extends ConfigurationErrorEvent> type,
EventType<?> opType,
String propName,
Object propValue,
Throwable ex)
Creates a
ConfigurationErrorEvent object based on the passed in
parameters. |
protected <T extends ConfigurationEvent> |
BaseEventSource.createEvent(EventType<T> type,
String propName,
Object propValue,
boolean before)
Creates a
ConfigurationEvent object based on the passed in
parameters. |
static Set<EventType<?>> |
EventType.fetchSuperEventTypes(EventType<?> eventType)
Returns a set with all event types that are super types of the specified
type.
|
<T extends ConfigurationErrorEvent> |
BaseEventSource.fireError(EventType<T> eventType,
EventType<?> operationType,
String propertyName,
Object propertyValue,
Throwable cause)
Creates an error event object and delivers it to all registered error
listeners of a matching type.
|
<T extends ConfigurationErrorEvent> |
BaseEventSource.fireError(EventType<T> eventType,
EventType<?> operationType,
String propertyName,
Object propertyValue,
Throwable cause)
Creates an error event object and delivers it to all registered error
listeners of a matching type.
|
protected <T extends ConfigurationEvent> |
BaseEventSource.fireEvent(EventType<T> type,
String propName,
Object propValue,
boolean before)
Creates an event object and delivers it to all registered event
listeners.
|
<T extends Event> |
EventListenerList.getEventListenerIterator(EventType<T> eventType)
Returns a specialized iterator for obtaining all event listeners stored
in this list which are compatible with the specified event type.
|
<T extends Event> |
BaseEventSource.getEventListeners(EventType<T> eventType)
Returns a collection with all event listeners of the specified event type
that are currently registered at this object.
|
<T extends Event> |
EventListenerList.getEventListeners(EventType<T> eventType)
Returns an
Iterable allowing access to all event listeners stored
in this list which are compatible with the specified event type. |
<T extends Event> |
EventListenerList.getRegistrationsForSuperType(EventType<T> eventType)
Returns a list with
EventListenerRegistrationData objects for all
event listener registrations of the specified event type or an event type
having this type as super type (directly or indirectly). |
static boolean |
EventType.isInstanceOf(EventType<?> derivedType,
EventType<?> baseType)
Checks whether an event type is derived from another type.
|
static boolean |
EventType.isInstanceOf(EventType<?> derivedType,
EventType<?> baseType)
Checks whether an event type is derived from another type.
|
<T extends Event> |
BaseEventSource.removeEventListener(EventType<T> eventType,
EventListener<? super T> listener) |
<T extends Event> |
EventSource.removeEventListener(EventType<T> eventType,
EventListener<? super T> listener)
Removes the event listener registration for the given event type and
listener.
|
<T extends Event> |
EventListenerList.removeEventListener(EventType<T> eventType,
EventListener<? super T> listener)
Removes the event listener registration for the given event type and
listener.
|
Constructor and Description |
---|
ConfigurationErrorEvent(Object source,
EventType<? extends ConfigurationErrorEvent> eventType,
EventType<?> operationType,
String propName,
Object propValue,
Throwable cause)
Creates a new instance of
ConfigurationErrorEvent and sets all
its properties. |
ConfigurationErrorEvent(Object source,
EventType<? extends ConfigurationErrorEvent> eventType,
EventType<?> operationType,
String propName,
Object propValue,
Throwable cause)
Creates a new instance of
ConfigurationErrorEvent and sets all
its properties. |
ConfigurationEvent(Object source,
EventType<? extends ConfigurationEvent> type,
String propertyName,
Object propertyValue,
boolean beforeUpdate)
Creates a new instance of
ConfigurationEvent and
initializes it. |
Event(Object source,
EventType<? extends Event> evType)
Creates a new instance of
Event and sets basic properties. |
EventListenerRegistrationData(EventType<T> type,
EventListener<? super T> lstnr)
Creates a new instance of
EventListenerRegistrationData . |
EventType(EventType<? super T> superEventType,
String typeName)
Creates a new instance of
EventType and initializes it with the
super type and a type name. |
Modifier and Type | Field and Description |
---|---|
static EventType<ReloadingEvent> |
ReloadingEvent.ANY
The common event super type for all reloading events.
|
Modifier and Type | Method and Description |
---|---|
<T extends Event> |
ReloadingController.addEventListener(EventType<T> eventType,
EventListener<? super T> listener)
Adds an event listener for the specified event type.
|
<T extends Event> |
ReloadingController.removeEventListener(EventType<T> eventType,
EventListener<? super T> listener) |
Copyright © 2001–2018 The Apache Software Foundation. All rights reserved.