Class ReloadingEvent
- java.lang.Object
-
- java.util.EventObject
-
- org.apache.commons.configuration2.event.Event
-
- org.apache.commons.configuration2.reloading.ReloadingEvent
-
- All Implemented Interfaces:
java.io.Serializable
public class ReloadingEvent extends Event
An event that is fired when a reload operation is required.
Events of this type are generated by
ReloadingController
if the need for a reload operation is detected. From the pay-load of the event information about the components involved is available.- Since:
- 2.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static EventType<ReloadingEvent>
ANY
The common event super type for all reloading events.
-
Constructor Summary
Constructors Constructor Description ReloadingEvent(ReloadingController source, java.lang.Object addData)
Creates a new instance ofReloadingEvent
and initializes it.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReloadingController
getController()
Gets theReloadingController
which caused this event.java.lang.Object
getData()
Gets an object with additional data about the reload operation.-
Methods inherited from class org.apache.commons.configuration2.event.Event
appendPropertyRepresentation, getEventType, toString
-
-
-
-
Field Detail
-
ANY
public static final EventType<ReloadingEvent> ANY
The common event super type for all reloading events.
-
-
Constructor Detail
-
ReloadingEvent
public ReloadingEvent(ReloadingController source, java.lang.Object addData)
Creates a new instance ofReloadingEvent
and initializes it.- Parameters:
source
- the controller which generated this eventaddData
- an arbitrary data object to be evaluated by event listeners
-
-
Method Detail
-
getController
public ReloadingController getController()
Gets theReloadingController
which caused this event.- Returns:
- the responsible
ReloadingController
-
getData
public java.lang.Object getData()
Gets an object with additional data about the reload operation. This is the object that was passed to theReloadingController
when it was asked to do a reloading check. This is a generic mechanism to pass arbitrary data to reloading listeners.- Returns:
- additional data about the reload operation (can be null)
-
-