Class ReloadingEvent

java.lang.Object
java.util.EventObject
org.apache.commons.configuration2.event.Event
org.apache.commons.configuration2.reloading.ReloadingEvent
All Implemented Interfaces:
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:
  • Field Details

  • Constructor Details

    • ReloadingEvent

      public ReloadingEvent(ReloadingController source, Object addData)
      Creates a new instance of ReloadingEvent and initializes it.
      Parameters:
      source - the controller which generated this event
      addData - an arbitrary data object to be evaluated by event listeners
  • Method Details

    • getController

      Gets the ReloadingController which caused this event.
      Returns:
      the responsible ReloadingController
    • getData

      public Object getData()
      Gets an object with additional data about the reload operation. This is the object that was passed to the ReloadingController 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)