org.apache.commons.configuration.event
public class ConfigurationEvent extends EventObject
An event class for reporting updates on a configuration object.
Event objects of this type are used for "raw" events, i.e. unfiltered modifications of any kind. A level with semantically higher events (e.g. for property changes) may be built on top of this fundamental event mechanism.
Each event can contain the following data:
The following standard events are generated by typical configuration
implementations (the constants for the event types are defined in
AbstractConfiguration
):
addProperty()
method of a configuration object. It contains the name of the property, to
which new data is added, and the value object that is added to this property
(this may be an array or a list if multiple values are added).setProperty()
method triggers this event. The
event object stores the name of the affected property and its new value.clearProperty()
method), an event of this type is fired. In
this case the event object only stores the name of the removed property, the
value is null.Since: 1.3
Version: $Id: ConfigurationEvent.java 443105 2006-09-13 20:04:01Z oheger $
Field Summary | |
---|---|
boolean | beforeUpdate Stores the before update flag. |
String | propertyName Stores the property name. |
Object | propertyValue Stores the property value. |
static long | serialVersionUID
The serial version UID. |
int | type Stores the event type. |
Constructor Summary | |
---|---|
ConfigurationEvent(Object source, int type, String propertyName, Object propertyValue, boolean beforeUpdate)
Creates a new instance of ConfigurationEvent and
initializes it.
|
Method Summary | |
---|---|
String | getPropertyName()
Returns the name of the affected property. |
Object | getPropertyValue()
Returns the value of the affected property if available.
|
int | getType()
Returns the type of this event. |
boolean | isBeforeUpdate()
Returns a flag if this event was generated before or after an update.
|
ConfigurationEvent
and
initializes it.
Parameters: source the event source type the event's type propertyName the name of the affected property propertyValue the value of the affected property beforeUpdate the before update flag
Returns: the name of the property
Returns: the value of the property; can be null
Returns: the event's type
Returns: true if this event was generated before an update; false otherwise