Class BasicBuilderParameters
java.lang.Object
org.apache.commons.configuration2.builder.BasicBuilderParameters
- All Implemented Interfaces:
Cloneable,BasicBuilderProperties<BasicBuilderParameters>,BuilderParameters
- Direct Known Subclasses:
CombinedBuilderParametersImpl,DatabaseBuilderParametersImpl,FileBasedBuilderParametersImpl,JndiBuilderParametersImpl,MultiFileBuilderParametersImpl
public class BasicBuilderParameters
extends Object
implements Cloneable, BuilderParameters, BasicBuilderProperties<BasicBuilderParameters>
An implementation of BuilderParameters which handles the parameters of a ConfigurationBuilder common
to all concrete Configuration implementations.
This class provides methods for setting standard properties supported by the AbstractConfiguration base
class. A fluent interface can be used to set property values.
This class is not thread-safe. It is intended that an instance is constructed and initialized by a single thread
during configuration of a ConfigurationBuilder.
- Since:
- 2.0
-
Field Summary
Fields inherited from interface org.apache.commons.configuration2.builder.BuilderParameters
RESERVED_PARAMETER_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Clones this object.protected voidcopyPropertiesFrom(Map<String, ?> source, String... keys) Copies a number of properties from the given map into this object.static BeanHelperfetchBeanHelper(Map<String, Object> params) Obtains theBeanHelperobject from the specified map with parameters.static InterpolatorSpecificationfetchInterpolatorSpecification(Map<String, Object> params) Obtains a specification for aConfigurationInterpolatorfrom the specified map with parameters.protected ObjectfetchProperty(String key) Obtains the value of the specified property from the internal map.Gets a map with all parameters defined by this objects.voidinheritFrom(Map<String, ?> source) Inherits properties from the specified map.voidMerges this object with the given parameters object.setBeanHelper(BeanHelper beanHelper) Sets aBeanHelperobject to be used by the configuration builder.Sets theConfigurationDecoderobject for this configuration.setConversionHandler(ConversionHandler handler) Sets theConversionHandlerobject for this configuration.setDefaultLookups(Collection<? extends Lookup> lookups) Adds additional defaultLookupobjects (i.e. lookups which are not associated with a specific prefix) to this configuration object.Sets theConfigurationInterpolatorto be used for this configuration.Sets the value of the listDelimiterHandler property.Sets the logger property.Sets the parentConfigurationInterpolatorfor this configuration'sConfigurationInterpolator.setPrefixLookups(Map<String, ? extends Lookup> lookups) Sets additionalLookupobjects for specific prefixes for this configuration object.setSynchronizer(Synchronizer sync) Sets theSynchronizerobject for this configuration.setThrowExceptionOnMissing(boolean b) Sets the value of the throwExceptionOnMissing property.protected voidstoreProperty(String key, Object value) Sets a property for this parameters object.
-
Constructor Details
-
BasicBuilderParameters
public BasicBuilderParameters()Creates a new instance ofBasicBuilderParameters.
-
-
Method Details
-
fetchBeanHelper
Obtains theBeanHelperobject from the specified map with parameters. This method can be used to obtain an instance from a parameters map that has been set via thesetBeanHelper()method. If no such instance is found, result is null.- Parameters:
params- the map with parameters (must not be null)- Returns:
- the
BeanHelperstored in this map or null - Throws:
IllegalArgumentException- if the map is null
-
fetchInterpolatorSpecification
Obtains a specification for aConfigurationInterpolatorfrom the specified map with parameters. All properties related to interpolation are evaluated and added to the specification object.- Parameters:
params- the map with parameters (must not be null)- Returns:
- an
InterpolatorSpecificationobject constructed with data from the map - Throws:
IllegalArgumentException- if the map is null or contains invalid data
-
clone
Clones this object. This is useful because multiple builder instances may use a similar set of parameters. However, single instances of parameter objects must not assigned to multiple builders. Therefore, cloning a parameters object provides a solution for this use case. This method creates a new parameters object with the same content as this one. The internal map storing the parameter values is cloned, too, also collection structures contained in this map. However, no a full deep clone operation is performed. Objects like aConfigurationInterpolatororLookups are shared between this and the newly created instance. -
copyPropertiesFrom
Copies a number of properties from the given map into this object. Properties are only copied if they are defined in the source map.- Parameters:
source- the source mapkeys- the keys to be copied
-
fetchProperty
Obtains the value of the specified property from the internal map. This method can be used by derived classes if a specific property is to be accessed. If the given key is not found, result is null.- Parameters:
key- the key of the property in question- Returns:
- the value of the property with this key or null
-
getParameters
Gets a map with all parameters defined by this objects. The keys of the map correspond to concrete properties supported by theConfigurationimplementation class the builder produces. The values are the corresponding property values. The return value must not be null. This implementation returns a copy of the internal parameters map with the values set so far. Collection structures (for example for lookup objects) are stored as defensive copies, so the original data cannot be modified.- Specified by:
getParametersin interfaceBuilderParameters- Returns:
- a map with builder parameters
-
inheritFrom
Inherits properties from the specified map. This can be used for instance to reuse parameters from one builder in another builder - also in parent-child relations in which a parent builder creates child builders. The purpose of this method is to let a concrete implementation decide which properties can be inherited. Because parameters are basically organized as a map it would be possible to simply copy over all properties from the source object. However, this is not appropriate in all cases. For instance, some properties - like aConfigurationInterpolator- are tightly connected to a configuration and cannot be reused in a different context. For other properties, for example a file name, it does not make sense to copy it. Therefore, an implementation has to be explicit in the properties it wants to take over.- Parameters:
source- the source properties to inherit from- Throws:
IllegalArgumentException- if the source map is null
-
merge
Merges this object with the given parameters object. This method adds all property values defined by the passed in parameters object to the internal storage which are not already in. So properties already defined in this object take precedence. Property names starting with the reserved parameter prefix are ignored.- Parameters:
p- the object whose properties should be merged (must not be null)- Throws:
IllegalArgumentException- if the passed in object is null
-
setBeanHelper
Sets aBeanHelperobject to be used by the configuration builder. TheBeanHelperis used to create the managed configuration instance dynamically. It is not a property of the configuration as most other properties defined by this interface. By setting an alternativeBeanHelperthe process of creating configuration instances via reflection can be adapted. (Some specialized configuration builder implementations also use aBeanHelperto create complex helper objects during construction of their result object.CombinedConfigurationBuilderfor instance supports a complex configuration definition format which may contain several specialized bean declarations.) If no specificBeanHelperis set, the builder uses the default instance. This implementation stores the passed inBeanHelperobject in the internal parameters map, but uses a reserved key, so that it is not used for the initialization of properties of the managed configuration object. ThefetchBeanHelper()method can be used to obtain theBeanHelperinstance from a parameters map.- Specified by:
setBeanHelperin interfaceBasicBuilderProperties<BasicBuilderParameters>- Parameters:
beanHelper- theBeanHelperto be used by the builder- Returns:
- a reference to this object for method chaining
-
setConfigurationDecoder
Sets theConfigurationDecoderobject for this configuration. This object is called when encoded properties are queried using thegetEncodedString()method. This implementation stores the passed inConfigurationDecoderobject in the internal parameters map.- Specified by:
setConfigurationDecoderin interfaceBasicBuilderProperties<BasicBuilderParameters>- Parameters:
decoder- theConfigurationDecoderto be used- Returns:
- a reference to this object for method chaining
-
setConversionHandler
Sets theConversionHandlerobject for this configuration. This object is responsible for all data type conversions required for accessing configuration properties in a specific target type. If this property is not set, a defaultConversionHandleris used. This implementation stores the passed inConversionHandlerobject in the internal parameters map.- Specified by:
setConversionHandlerin interfaceBasicBuilderProperties<BasicBuilderParameters>- Parameters:
handler- theConversionHandlerto be used- Returns:
- a reference to this object for method chaining
-
setDefaultLookups
Adds additional defaultLookupobjects (i.e. lookups which are not associated with a specific prefix) to this configuration object. Note: This method only takes effect if noConfigurationInterpolatoris set using theBasicBuilderProperties.setInterpolator(ConfigurationInterpolator)method. A defensive copy of the passed in collection is created. A null argument causes all default lookups to be removed from the internal parameters map.- Specified by:
setDefaultLookupsin interfaceBasicBuilderProperties<BasicBuilderParameters>- Parameters:
lookups- a collection withLookupobjects to be added as default lookups at the configuration'sConfigurationInterpolator- Returns:
- a reference to this object for method chaining
- See Also:
-
setInterpolator
Sets theConfigurationInterpolatorto be used for this configuration. Using this method a customConfigurationInterpolatorcan be set which can be freely configured. Alternatively, it is possible to add customLookupobjects using other methods provided by this interface. The passed inConfigurationInterpolatoris set without modifications.- Specified by:
setInterpolatorin interfaceBasicBuilderProperties<BasicBuilderParameters>- Parameters:
ci- theConfigurationInterpolatorfor this configuration- Returns:
- a reference to this object for method chaining
-
setListDelimiterHandler
Sets the value of the listDelimiterHandler property. This property defines the object responsible for dealing with list delimiter and escaping characters. Note:AbstractConfigurationdoes not allow setting this property to null. If the defaultListDelimiterHandleris to be used, do not call this method.- Specified by:
setListDelimiterHandlerin interfaceBasicBuilderProperties<BasicBuilderParameters>- Parameters:
handler- theListDelimiterHandler- Returns:
- a reference to this object for method chaining
-
setLogger
Sets the logger property. With this property a concreteLogobject can be set for the configuration. Thus logging behavior can be controlled.- Specified by:
setLoggerin interfaceBasicBuilderProperties<BasicBuilderParameters>- Parameters:
log- theLogfor the configuration produced by this builder- Returns:
- a reference to this object for method chaining
-
setParentInterpolator
Sets the parentConfigurationInterpolatorfor this configuration'sConfigurationInterpolator. Setting a parentConfigurationInterpolatorcan be used for defining a default behavior for variables which cannot be resolved. This implementation stores the passed inConfigurationInterpolatorobject in the internal parameters map.- Specified by:
setParentInterpolatorin interfaceBasicBuilderProperties<BasicBuilderParameters>- Parameters:
parent- the new parentConfigurationInterpolator- Returns:
- a reference to this object for method chaining
- See Also:
-
setPrefixLookups
Sets additionalLookupobjects for specific prefixes for this configuration object. AllLookupobjects contained in the given map are added to the configuration'sConfigurationInterpolator. Note: This method only takes effect if noConfigurationInterpolatoris set using theBasicBuilderProperties.setInterpolator(ConfigurationInterpolator)method. A defensive copy of the passed in map is created. A null argument causes all prefix lookups to be removed from the internal parameters map.- Specified by:
setPrefixLookupsin interfaceBasicBuilderProperties<BasicBuilderParameters>- Parameters:
lookups- a map withLookupobjects and their associated prefixes- Returns:
- a reference to this object for method chaining
- See Also:
-
setSynchronizer
Sets theSynchronizerobject for this configuration. This object is used to protect this configuration instance against concurrent access. The concreteSynchronizerimplementation used determines whether a configuration instance is thread-safe or not. This implementation stores the passed inSynchronizerobject in the internal parameters map.- Specified by:
setSynchronizerin interfaceBasicBuilderProperties<BasicBuilderParameters>- Parameters:
sync- theSynchronizerto be used (a value of null means that a defaultSynchronizeris used)- Returns:
- a reference to this object for method chaining
-
setThrowExceptionOnMissing
Sets the value of the throwExceptionOnMissing property. This property controls the configuration's behavior if missing properties are queried: a value of true causes the configuration to throw an exception, for a value of false it will return null values. (Note: Methods returning a primitive data type will always throw an exception if the property is not defined.)- Specified by:
setThrowExceptionOnMissingin interfaceBasicBuilderProperties<BasicBuilderParameters>- Parameters:
b- the value of the property- Returns:
- a reference to this object for method chaining
-
storeProperty
Sets a property for this parameters object. Properties are stored in an internal map. With this method a new entry can be added to this map. If the value is null, the key is removed from the internal map. This method can be used by sub classes which also store properties in a map.- Parameters:
key- the key of the propertyvalue- the value of the property
-