Package org.apache.commons.configuration2.builder

Interface DefaultParametersHandler<T>

Type Parameters:
T - the type of parameters supported by this handler
All Known Implementing Classes:
CopyObjectDefaultHandler
public interface DefaultParametersHandler<T>

Definition of an interface for setting default values for specific configuration parameter objects.

An object implementing this interface knows how to initialize a parameters object of a specific class with default values. Such objects can be registered at the Parameters class. Whenever a specific parameters object is created all registered DefaultParametersHandler objects that can handle this parameters type are invoked, so that they get the chance to perform arbitrary initialization.

Since:
2.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    initializeDefaults(T parameters)
    Initializes the specified parameters object with default values.

  • Method Details

    • initializeDefaults

      void initializeDefaults(T parameters)
      Initializes the specified parameters object with default values. This method is called after the parameters object was created and before it is passed to the calling code. A concrete implementation can perform arbitrary initializations. Note that if there are multiple DefaultParametersHandler objects registered supporting this parameters type they are called in the order they have been registered. So handlers registered later can override initializations done by handlers registered earlier.
      Parameters:
      parameters - the parameters object to be initialized