Package org.apache.commons.configuration2.builder

Interface EventListenerProvider

All Known Implementing Classes:
EventListenerParameters
public interface EventListenerProvider

Definition of an interface that is evaluated by a ConfigurationBuilder to initialize event listeners.

This interface allows a convenient initialization of a configuration builder with event listeners to be registered at the managed configuration object. The configure() method of BasicConfigurationBuilder checks whether a parameters object passed to it implements this interface. If this is the case, all event listeners defined by the object are added to the internal list managed by the builder. They are then automatically registered at the managed configuration when it is created. When using a corresponding implementation the configuration of event listeners can be done in the same fluent API style as the other initialization of the configuration builder.

Since:
2.0

  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    EventListenerList
    getListeners()
    Gets an EventListenerList object with information about event listener registrations.

  • Method Details Link icon

    • getListeners Link icon

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