Class FileBasedConfigurationBuilder<T extends FileBasedConfiguration>
- java.lang.Object
-
- org.apache.commons.configuration2.builder.BasicConfigurationBuilder<T>
-
- org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder<T>
-
- Type Parameters:
T- the concrete type ofConfigurationobjects created by this builder
- All Implemented Interfaces:
ConfigurationBuilder<T>,EventSource
- Direct Known Subclasses:
ReloadingFileBasedConfigurationBuilder
public class FileBasedConfigurationBuilder<T extends FileBasedConfiguration> extends BasicConfigurationBuilder<T>
A specialized
ConfigurationBuilderimplementation which can handle configurations read from aFileHandler.This class extends its base class by the support of a
FileBasedBuilderParametersImplobject, and especially of theFileHandlercontained in this object. When the builder creates a new object the resultingConfigurationinstance is associated with theFileHandler. If theFileHandlerhas a location set, theConfigurationis directly loaded from this location.The
FileHandleris kept by this builder and can be queried later on. It can be used for instance to save the currentConfigurationafter it was modified. Some care has to be taken when changing the location of theFileHandler: The new location is recorded and also survives an invocation of theresetResult()method. However, when the builder's initialization parameters are reset by callingresetParameters()the location is reset, too.- Since:
- 2.0
-
-
Constructor Summary
Constructors Constructor Description FileBasedConfigurationBuilder(Class<? extends T> resCls)Creates a new instance ofFileBasedConfigurationBuilderwhich produces result objects of the specified class.FileBasedConfigurationBuilder(Class<? extends T> resCls, Map<String,Object> params)Creates a new instance ofFileBasedConfigurationBuilderwhich produces result objects of the specified class and sets initialization parameters.FileBasedConfigurationBuilder(Class<? extends T> resCls, Map<String,Object> params, boolean allowFailOnInit)Creates a new instance ofFileBasedConfigurationBuilderwhich produces result objects of the specified class and sets initialization parameters and the allowFailOnInit flag.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FileBasedConfigurationBuilder<T>configure(BuilderParameters... params)Appends the content of the specifiedBuilderParametersobjects to the current initialization parameters.static StringgetDefaultEncoding(Class<?> configClass)Gets the default encoding for the specified configuration class.FileHandlergetFileHandler()Gets theFileHandlerassociated with this builder.protected voidinitFileHandler(FileHandler handler)Initializes the new currentFileHandler.protected voidinitResultInstance(T obj)Initializes a newly created result object.booleanisAutoSave()Gets a flag whether auto save mode is currently active.voidsave()Convenience method which saves the associated configuration.voidsetAutoSave(boolean enabled)Enables or disables auto save mode.static voidsetDefaultEncoding(Class<?> configClass, String encoding)Sets a default encoding for a specific configuration class.BasicConfigurationBuilder<T>setParameters(Map<String,Object> params)Sets the initialization parameters of this builder.-
Methods inherited from class org.apache.commons.configuration2.builder.BasicConfigurationBuilder
addEventListener, addParameters, connectToReloadingController, copyEventListeners, copyEventListeners, createResult, createResultDeclaration, createResultInstance, fetchBeanHelper, fireBuilderEvent, getConfiguration, getParameters, getResultClass, getResultDeclaration, installEventListener, isAllowFailOnInit, removeEventListener, reset, resetParameters, resetResult
-
-
-
-
Constructor Detail
-
FileBasedConfigurationBuilder
public FileBasedConfigurationBuilder(Class<? extends T> resCls)
Creates a new instance ofFileBasedConfigurationBuilderwhich produces result objects of the specified class.- Parameters:
resCls- the result class (must not be null- Throws:
IllegalArgumentException- if the result class is null
-
FileBasedConfigurationBuilder
public FileBasedConfigurationBuilder(Class<? extends T> resCls, Map<String,Object> params)
Creates a new instance ofFileBasedConfigurationBuilderwhich produces result objects of the specified class and sets initialization parameters.- Parameters:
resCls- the result class (must not be nullparams- a map with initialization parameters- Throws:
IllegalArgumentException- if the result class is null
-
FileBasedConfigurationBuilder
public FileBasedConfigurationBuilder(Class<? extends T> resCls, Map<String,Object> params, boolean allowFailOnInit)
Creates a new instance ofFileBasedConfigurationBuilderwhich produces result objects of the specified class and sets initialization parameters and the allowFailOnInit flag.- Parameters:
resCls- the result class (must not be nullparams- a map with initialization parametersallowFailOnInit- the allowFailOnInit flag- Throws:
IllegalArgumentException- if the result class is null
-
-
Method Detail
-
getDefaultEncoding
public static String getDefaultEncoding(Class<?> configClass)
Gets the default encoding for the specified configuration class. If an encoding has been set for the specified class (or one of its super classes), it is returned. Otherwise, result is null.- Parameters:
configClass- the configuration class in question- Returns:
- the default encoding for this class (may be null)
-
setDefaultEncoding
public static void setDefaultEncoding(Class<?> configClass, String encoding)
Sets a default encoding for a specific configuration class. This encoding is used if an instance of this configuration class is to be created and no encoding has been set in the parameters object for this builder. The encoding passed here not only applies to the specified class but also to its sub classes. If the encoding is null, it is removed.- Parameters:
configClass- the name of the configuration class (must not be null)encoding- the default encoding for this class- Throws:
IllegalArgumentException- if the class is null
-
configure
public FileBasedConfigurationBuilder<T> configure(BuilderParameters... params)
Appends the content of the specifiedBuilderParametersobjects to the current initialization parameters. Calling this method multiple times will create a union of the parameters provided. This method is overridden here to change the result type.- Overrides:
configurein classBasicConfigurationBuilder<T extends FileBasedConfiguration>- Parameters:
params- an arbitrary number of objects with builder parameters- Returns:
- a reference to this builder for method chaining
-
getFileHandler
public FileHandler getFileHandler()
Gets theFileHandlerassociated with this builder. If already a result object has been created, thisFileHandlercan be used to save it. Otherwise, theFileHandlerfrom the initialization parameters is returned (which is not associated with aFileBasedobject). Result is never null.- Returns:
- the
FileHandlerassociated with this builder
-
setParameters
public BasicConfigurationBuilder<T> setParameters(Map<String,Object> params)
Sets the initialization parameters of this builder. Already existing parameters are replaced by the content of the given map. This implementation just records the fact that new parameters have been set. This means that the next time a result object is created, theFileHandlerhas to be initialized from initialization parameters rather than reusing the existing one.- Overrides:
setParametersin classBasicConfigurationBuilder<T extends FileBasedConfiguration>- Parameters:
params- the new initialization parameters of this builder; can be null, then all initialization parameters are removed- Returns:
- a reference to this builder for method chaining
-
save
public void save() throws ConfigurationException
Convenience method which saves the associated configuration. This method expects that the managed configuration has already been created and that a valid file location is available in the currentFileHandler. The file handler is then used to store the configuration.- Throws:
ConfigurationException- if an error occurs
-
isAutoSave
public boolean isAutoSave()
Gets a flag whether auto save mode is currently active.- Returns:
- true if auto save is enabled, false otherwise
-
setAutoSave
public void setAutoSave(boolean enabled)
Enables or disables auto save mode. If auto save mode is enabled, every update of the managed configuration causes it to be saved automatically; so changes are directly written to disk.- Parameters:
enabled- true if auto save mode is to be enabled, false otherwise
-
initResultInstance
protected void initResultInstance(T obj) throws ConfigurationException
Initializes a newly created result object. This is the second step of the process of producing a result object for this builder. This implementation uses theBeanHelperclass to initialize the object's property based on theBeanDeclarationreturned byBasicConfigurationBuilder.getResultDeclaration(). Note: This method is invoked in a synchronized block. This is required because internal state is accessed. Sub classes must not call this method without proper synchronization. This implementation deals with the creation and initialization of aFileHandlerassociated with the new result object.- Overrides:
initResultInstancein classBasicConfigurationBuilder<T extends FileBasedConfiguration>- Parameters:
obj- the object to be initialized- Throws:
ConfigurationException- if an error occurs
-
initFileHandler
protected void initFileHandler(FileHandler handler) throws ConfigurationException
Initializes the new currentFileHandler. When a new result object is created, a newFileHandleris created, too, and associated with the result object. This new handler is passed to this method. If a location is defined, the result object is loaded from this location. Note: This method is called from a synchronized block.- Parameters:
handler- the new currentFileHandler- Throws:
ConfigurationException- if an error occurs
-
-