| java.lang.Object
 java.util.EventObject
org.apache.commons.configuration.event.ConfigurationEvent
All known Subclasses: org.apache.commons.configuration.event.ConfigurationErrorEvent,
| ConfigurationEvent | | public class ConfigurationEvent extends EventObject (Code) | |
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:
- A source object, which is usually the configuration object that was
modified.
- The event's type. This is a numeric value that corresponds to constant
declarations in concrete configuration classes. It describes what exactly has
happended.
- If available, the name of the property whose modification caused the
event.
- If available, the value of the property that caused this event.
- A flag whether this event was generated before or after the update of
the source configuration. A modification of a configuration typically causes
two events: one event before and one event after the modification is
performed. This allows event listeners to react at the correct point of time.
The following standard events are generated by typical configuration
implementations (the constants for the event types are defined in
org.apache.commons.configuration.AbstractConfiguration ):
- EVENT_ADD_PROPERTY
- This event is triggered for each call of the
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).
- EVENT_SET_PROPERTY
- Calling the
setProperty() method triggers this event. The
event object stores the name of the affected property and its new value.
- EVENT_CLEAR_PROPERTY
- If a property is removed from a configuration (by calling the
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.
- EVENT_CLEAR
- This event is fired when the whole configuration is cleared. The
corresponding event object contains no additional data.
author:
author:
href="http://jakarta.apache.org/commons/configuration/team-list.html">Commons
author:
Configuration team
version:
$Id: ConfigurationEvent.java 443105 2006-09-13 20:04:01Z oheger $
since:
1.3 |
| Constructor Summary | |
| public | ConfigurationEvent(Object source, int type, String propertyName, Object propertyValue, boolean beforeUpdate)
Creates a new instance of ConfigurationEvent and
initializes it. |
| Method Summary | |
| public String | getPropertyName()
Returns the name of the affected property. | | public Object | getPropertyValue()
Returns the value of the affected property if available. | | public int | getType()
Returns the type of this event. | | public boolean | isBeforeUpdate()
Returns a flag if this event was generated before or after an update. |
| ConfigurationEvent | | public ConfigurationEvent(Object source, int type, String propertyName, Object propertyValue, boolean beforeUpdate)(Code) | | Creates a new instance of ConfigurationEvent and
initializes it.
Parameters:
source - the event source
Parameters:
type - the event's type
Parameters:
propertyName - the name of the affected property
Parameters:
propertyValue - the value of the affected property
Parameters:
beforeUpdate - the before update flag |
| getPropertyName | | public String getPropertyName()(Code) | | Returns the name of the affected property. This can be null if no
property change has lead to this event.
the name of the property |
| getPropertyValue | | public Object getPropertyValue()(Code) | | Returns the value of the affected property if available.
the value of the property; can be null |
| getType | | public int getType()(Code) | | Returns the type of this event. This describes the update process that
caused this event.
the event's type |
| isBeforeUpdate | | public boolean isBeforeUpdate()(Code) | | Returns a flag if this event was generated before or after an update.
true if this event was generated before an update;false otherwise |
|
|