Class EventListenerParameters

java.lang.Object
org.apache.commons.configuration2.builder.EventListenerParameters
All Implemented Interfaces:
BuilderParameters, EventListenerProvider

A specialized parameters implementation for BasicConfigurationBuilder which allows for a convenient event listener initialization.

This class offers a fluent interface for registering event listeners. A fully initialized instance can be passed to the BasicConfigurationBuilder.configure(BuilderParameters...) method. All event listeners which have been registered at the instance are then copied over to the configuration builder.

The code fragment below shows a typical usage scenario:

 BasicConfigurationBuilder<Configuration> builder = new BasicConfigurationBuilder<Configuration>(PropertiesConfiguration.class)
     .configure(new EventListenerParameters().addEventListener(ConfigurationEvent.ANY, myListener));
 

In order to support a configuration builder's configure() method, this class implements the BuilderParameters interface. However, this is just a dummy implementation; no parameters are propagated to the builder.

Since:
2.0
  • Constructor Details

  • Method Details

    • addEventListener

      public <T extends Event> EventListenerParameters addEventListener(EventType<T> eventType, EventListener<? super T> listener)
      Adds an event listener of the specified event type to this object.
      Type Parameters:
      T - the event type
      Parameters:
      eventType - the event type object
      listener - the event listener
      Returns:
      a reference to this object for method chaining
    • addEventListener

      Adds the specified EventListenerRegistrationData instance to this object.
      Type Parameters:
      T - the event type of the contained event listener
      Parameters:
      registrationData - the registration object to be added
      Returns:
      a reference to this object for method chaining
    • getParameters

      Gets a map with all parameters defined by this objects. The keys of the map correspond to concrete properties supported by the Configuration implementation class the builder produces. The values are the corresponding property values. The return value must not be null. This implementation returns an empty map.
      Specified by:
      getParameters in interface BuilderParameters
      Returns:
      a map with builder parameters
    • getListeners

      Description copied from interface: EventListenerProvider
      Gets an EventListenerList object with information about event listener registrations. All listeners contained in this object are added to the processing ConfigurationBuilder.
      Specified by:
      getListeners in interface EventListenerProvider
      Returns:
      the EventListenerList with event listener registrations (must not be null)