A convenience class for creating parameter objects for initializing configuration builder objects.
For setting initialization properties of new configuration objects, a number of specialized parameter classes exists. These classes use inheritance to organize the properties they support in a logic way. For instance, parameters for file-based configurations also support the basic properties common to all configuration implementations, parameters for XML configurations also include file-based and basic properties, etc.
When constructing a configuration builder, an easy-to-use fluent API is desired to define specific properties for the configuration to be created. However, the inheritance structure of the parameter classes makes it surprisingly difficult to provide such an API. This class comes to rescue by defining a set of methods for the creation of interface-based parameter objects offering a truly fluent API. The methods provided can be called directly when setting up a configuration builder as shown in the following example code fragment:
Parameters params = new Parameters(); configurationBuilder.configure(params.fileBased() .setThrowExceptionOnMissing(true).setEncoding("UTF-8") .setListDelimiter('#').setFileName("test.xml")); Using this class it is not only possible to create new parameters objects but also to initialize the newly created objects with default values. This is via the associated {@link DefaultParametersManager} object. Such an objectcan be passed to the constructor, or a new (uninitialized) instance is created. There are convenience methods for interacting with the associated {@code DefaultParametersManager}, namely to register or remove {@link DefaultParametersHandler} objects. On all newly created parametersobjects the handlers registered at the associated {@code DefaultParametersHandler}are automatically applied.
Implementation note: This class is thread-safe.
@version $Id: Parameters.java 1624601 2014-09-12 18:04:36Z oheger $
@since 2.0