| Package | Description |
|---|---|
| org.apache.commons.configuration2 |
The Configuration main package.
|
| org.apache.commons.configuration2.builder |
This package contains the implementations of configuration builder
classes used to create new
Configuration objects. |
| org.apache.commons.configuration2.builder.combined |
A package containing the implementation of the builder for combined
configurations.
|
| org.apache.commons.configuration2.builder.fluent |
This package defines a fluent API for setting up fully configured configuration
builders.
|
| org.apache.commons.configuration2.io |
A package with classes related to I/O operations.
|
| org.apache.commons.configuration2.plist |
Configuration classes supporting NeXT / OpenStep /GNUStep style configuration.
|
| Modifier and Type | Method | Description |
|---|---|---|
protected javax.xml.transform.Transformer |
XMLConfiguration.createTransformer() |
Creates and initializes the transformer used for save operations.
|
void |
YAMLConfiguration.dump(java.io.Writer out,
org.yaml.snakeyaml.DumperOptions options) |
|
void |
PropertiesConfigurationLayout.load(PropertiesConfiguration config,
java.io.Reader in) |
Reads a properties file and stores its internal structure.
|
void |
XMLPropertiesConfiguration.load(org.w3c.dom.Element element) |
Parses a DOM element containing the properties.
|
void |
INIConfiguration.read(java.io.Reader in) |
Load the configuration from the given reader.
|
void |
JSONConfiguration.read(java.io.InputStream in) |
Loads the configuration from the given input stream.
|
void |
JSONConfiguration.read(java.io.Reader in) |
|
void |
PatternSubtreeConfigurationWrapper.read(java.io.Reader reader) |
|
void |
PropertiesConfiguration.read(java.io.Reader in) |
Reads the content of this object from the given reader.
|
void |
XMLConfiguration.read(java.io.InputStream in) |
Loads the configuration from the given input stream.
|
void |
XMLConfiguration.read(java.io.Reader in) |
Loads the configuration from the given reader.
|
void |
XMLPropertiesConfiguration.read(java.io.Reader in) |
|
void |
YAMLConfiguration.read(java.io.InputStream in) |
Loads the configuration from the given input stream.
|
void |
YAMLConfiguration.read(java.io.InputStream in,
org.yaml.snakeyaml.LoaderOptions options) |
|
void |
YAMLConfiguration.read(java.io.Reader in) |
|
void |
YAMLConfiguration.read(java.io.Reader in,
org.yaml.snakeyaml.LoaderOptions options) |
|
void |
PropertiesConfigurationLayout.save(PropertiesConfiguration config,
java.io.Writer out) |
Writes the properties file to the given writer, preserving as much of its
structure as possible.
|
static void |
SystemConfiguration.setSystemProperties(java.lang.String fileName) |
Sets system properties from a file specified by its file name.
|
static void |
SystemConfiguration.setSystemProperties(java.lang.String basePath,
java.lang.String fileName) |
Sets system properties from a file specified using its base path and
file name.
|
void |
XMLConfiguration.validate() |
Validate the document against the Schema.
|
void |
INIConfiguration.write(java.io.Writer writer) |
Save the configuration to the specified writer.
|
void |
JSONConfiguration.write(java.io.Writer out) |
|
void |
PatternSubtreeConfigurationWrapper.write(java.io.Writer writer) |
|
void |
PropertiesConfiguration.write(java.io.Writer out) |
Writes the content of this object to the given writer.
|
void |
XMLConfiguration.write(java.io.Writer writer) |
Saves the configuration to the specified writer.
|
void |
XMLPropertiesConfiguration.write(java.io.Writer out) |
|
void |
YAMLConfiguration.write(java.io.Writer out) |
| Constructor | Description |
|---|---|
XMLPropertiesConfiguration(org.w3c.dom.Element element) |
Creates and loads the xml properties from the specified DOM node.
|
| Modifier and Type | Method | Description |
|---|---|---|
ReloadingDetector |
DefaultReloadingDetectorFactory.createReloadingDetector(FileHandler handler,
FileBasedBuilderParametersImpl params) |
|
ReloadingDetector |
ReloadingDetectorFactory.createReloadingDetector(FileHandler handler,
FileBasedBuilderParametersImpl params) |
Creates a new
ReloadingDetector object based on the passed in
parameters. |
protected ReloadingDetector |
ReloadingFileBasedConfigurationBuilder.createReloadingDetector(FileHandler handler,
FileBasedBuilderParametersImpl fbparams) |
Creates a
ReloadingDetector which monitors the passed in
FileHandler. |
protected T |
BasicConfigurationBuilder.createResult() |
Creates a new, initialized result object.
|
protected BeanDeclaration |
BasicConfigurationBuilder.createResultDeclaration(java.util.Map<java.lang.String,java.lang.Object> params) |
Creates a new
BeanDeclaration which is used for creating new
result objects dynamically. |
protected T |
BasicConfigurationBuilder.createResultInstance() |
Creates the new, uninitialized result object.
|
T |
BasicConfigurationBuilder.getConfiguration() |
Returns the configuration provided by this builder.
|
T |
ConfigurationBuilder.getConfiguration() |
Returns the configuration provided by this builder.
|
protected BeanDeclaration |
BasicConfigurationBuilder.getResultDeclaration() |
Returns the
BeanDeclaration that is used to create and initialize
result objects. |
protected void |
FileBasedConfigurationBuilder.initFileHandler(FileHandler handler) |
Initializes the new current
FileHandler. |
protected void |
ReloadingFileBasedConfigurationBuilder.initFileHandler(FileHandler handler) |
Initializes the new current
FileHandler. |
protected void |
BasicConfigurationBuilder.initResultInstance(T obj) |
Initializes a newly created result object.
|
protected void |
FileBasedConfigurationBuilder.initResultInstance(T obj) |
Initializes a newly created result object.
|
void |
FileBasedConfigurationBuilder.save() |
Convenience method which saves the associated configuration.
|
| Modifier and Type | Method | Description |
|---|---|---|
protected void |
CombinedConfigurationBuilder.configureEntityResolver(HierarchicalConfiguration<?> config,
XMLBuilderParametersImpl xmlParams) |
Creates and initializes a default
EntityResolver if the
definition configuration contains a corresponding declaration. |
protected FileBasedConfigurationBuilder<T> |
MultiFileConfigurationBuilder.createInitializedManagedBuilder(java.lang.String fileName,
java.util.Map<java.lang.String,java.lang.Object> params) |
Creates a fully initialized builder for a managed configuration.
|
protected FileBasedConfigurationBuilder<T> |
MultiFileConfigurationBuilder.createManagedBuilder(java.lang.String fileName,
java.util.Map<java.lang.String,java.lang.Object> params) |
Creates a builder for a managed configuration.
|
protected FileBasedConfigurationBuilder<T> |
ReloadingMultiFileConfigurationBuilder.createManagedBuilder(java.lang.String fileName,
java.util.Map<java.lang.String,java.lang.Object> params) |
Creates a builder for a managed configuration.
|
protected ReloadingController |
ReloadingCombinedConfigurationBuilder.createReloadingController() |
Creates the
ReloadingController for this builder. |
protected BeanDeclaration |
CombinedConfigurationBuilder.createResultDeclaration(java.util.Map<java.lang.String,java.lang.Object> params) |
Creates a new
BeanDeclaration which is used for creating new
result objects dynamically. |
protected java.lang.String |
BaseConfigurationBuilderProvider.determineBuilderClass(ConfigurationDeclaration decl) |
Determines the name of the class to be used for a new builder instance.
|
protected java.lang.String |
BaseConfigurationBuilderProvider.determineConfigurationClass(ConfigurationDeclaration decl,
java.util.Collection<BuilderParameters> params) |
Determines the name of the configuration class produced by the builder.
|
protected java.lang.String |
FileExtensionConfigurationBuilderProvider.determineConfigurationClass(ConfigurationDeclaration decl,
java.util.Collection<BuilderParameters> params) |
Determines the name of the configuration class produced by the builder.
|
T |
MultiFileConfigurationBuilder.getConfiguration() |
Returns the configuration provided by this builder.
|
ConfigurationBuilder<? extends Configuration> |
BaseConfigurationBuilderProvider.getConfigurationBuilder(ConfigurationDeclaration decl) |
Returns the builder for the configuration source managed by this
provider.
|
ConfigurationBuilder<? extends Configuration> |
ConfigurationBuilderProvider.getConfigurationBuilder(ConfigurationDeclaration decl) |
Returns the builder for the configuration source managed by this
provider.
|
ConfigurationBuilder<? extends Configuration> |
MultiFileConfigurationBuilderProvider.getConfigurationBuilder(ConfigurationDeclaration decl) |
Returns the builder for the configuration source managed by this
provider.
|
ConfigurationBuilder<? extends HierarchicalConfiguration<?>> |
CombinedConfigurationBuilder.getDefinitionBuilder() |
Returns the
ConfigurationBuilder which creates the definition
configuration. |
protected HierarchicalConfiguration<?> |
CombinedConfigurationBuilder.getDefinitionConfiguration() |
Returns the configuration containing the definition of the combined
configuration to be created.
|
FileBasedConfigurationBuilder<T> |
MultiFileConfigurationBuilder.getManagedBuilder() |
Returns the managed
FileBasedConfigurationBuilder for the current
file name pattern. |
ConfigurationBuilder<? extends Configuration> |
CombinedConfigurationBuilder.getNamedBuilder(java.lang.String name) |
Returns the configuration builder with the given name.
|
protected FileSystem |
CombinedConfigurationBuilder.initFileSystem(HierarchicalConfiguration<?> config) |
Creates and initializes a default
FileSystem if the definition
configuration contains a corresponding declaration. |
protected void |
CombinedConfigurationBuilder.initResultInstance(CombinedConfiguration result) |
Initializes a newly created result object.
|
protected void |
ReloadingCombinedConfigurationBuilder.initResultInstance(CombinedConfiguration result) |
Initializes a newly created result object.
|
protected void |
CombinedConfigurationBuilder.initSystemProperties(HierarchicalConfiguration<?> config,
java.lang.String basePath) |
Handles a file with system properties that may be defined in the
definition configuration.
|
protected void |
CombinedConfigurationBuilder.registerConfiguredLookups(HierarchicalConfiguration<?> defConfig,
Configuration resultConfig) |
Processes custom
Lookup objects that might be declared in the
definition configuration. |
protected ConfigurationBuilder<? extends HierarchicalConfiguration<?>> |
CombinedConfigurationBuilder.setupDefinitionBuilder(java.util.Map<java.lang.String,java.lang.Object> params) |
Obtains the
ConfigurationBuilder object which provides access to
the configuration containing the definition of the combined configuration
to create. |
| Modifier and Type | Method | Description |
|---|---|---|
CombinedConfiguration |
Configurations.combined(java.io.File file) |
Creates a
CombinedConfiguration instance from the content of the
given file. |
CombinedConfiguration |
Configurations.combined(java.lang.String path) |
Creates a
CombinedConfiguration instance from the content of the
file identified by the given path. |
CombinedConfiguration |
Configurations.combined(java.net.URL url) |
Creates a
CombinedConfiguration instance from the content of the
given URL. |
<T extends FileBasedConfiguration> |
Configurations.fileBased(java.lang.Class<T> configClass,
java.io.File file) |
Creates an instance of the specified file-based configuration class from
the content of the given file.
|
<T extends FileBasedConfiguration> |
Configurations.fileBased(java.lang.Class<T> configClass,
java.lang.String path) |
Creates an instance of the specified file-based configuration class from
the content of the file identified by the given path.
|
<T extends FileBasedConfiguration> |
Configurations.fileBased(java.lang.Class<T> configClass,
java.net.URL url) |
Creates an instance of the specified file-based configuration class from
the content of the given URL.
|
INIConfiguration |
Configurations.ini(java.io.File file) |
Creates a
INIConfiguration instance from the content of the given
file. |
INIConfiguration |
Configurations.ini(java.lang.String path) |
Creates a
INIConfiguration instance from the content of the file
identified by the given path. |
INIConfiguration |
Configurations.ini(java.net.URL url) |
Creates a
INIConfiguration instance from the content of the given
URL. |
PropertiesConfiguration |
Configurations.properties(java.io.File file) |
Creates a
PropertiesConfiguration instance from the content of
the given file. |
PropertiesConfiguration |
Configurations.properties(java.lang.String path) |
Creates a
PropertiesConfiguration instance from the content of
the file identified by the given path. |
PropertiesConfiguration |
Configurations.properties(java.net.URL url) |
Creates a
PropertiesConfiguration instance from the content of
the given URL. |
XMLConfiguration |
Configurations.xml(java.io.File file) |
Creates a
XMLConfiguration instance from the content of the given
file. |
XMLConfiguration |
Configurations.xml(java.lang.String path) |
Creates a
XMLConfiguration instance from the content of the file
identified by the given path. |
XMLConfiguration |
Configurations.xml(java.net.URL url) |
Creates a
XMLConfiguration instance from the content of the given
URL. |
| Modifier and Type | Method | Description |
|---|---|---|
java.io.InputStream |
DefaultFileSystem.getInputStream(java.net.URL url) |
|
abstract java.io.InputStream |
FileSystem.getInputStream(java.net.URL url) |
|
java.io.InputStream |
VFSFileSystem.getInputStream(java.net.URL url) |
|
java.io.OutputStream |
DefaultFileSystem.getOutputStream(java.io.File file) |
|
java.io.OutputStream |
DefaultFileSystem.getOutputStream(java.net.URL url) |
|
abstract java.io.OutputStream |
FileSystem.getOutputStream(java.io.File file) |
|
abstract java.io.OutputStream |
FileSystem.getOutputStream(java.net.URL url) |
|
java.io.OutputStream |
VFSFileSystem.getOutputStream(java.net.URL url) |
|
void |
FileHandler.load() |
Loads the associated file from the underlying location.
|
void |
FileHandler.load(java.io.File file) |
Loads the associated file from the specified
File. |
void |
FileHandler.load(java.io.InputStream in) |
Loads the associated file from the specified stream, using the encoding
returned by
FileHandler.getEncoding(). |
void |
FileHandler.load(java.io.InputStream in,
java.lang.String encoding) |
Loads the associated file from the specified stream, using the specified
encoding.
|
void |
FileHandler.load(java.io.Reader in) |
Loads the associated file from the specified reader.
|
void |
FileHandler.load(java.lang.String fileName) |
Loads the associated file from the given file name.
|
void |
FileHandler.load(java.net.URL url) |
Loads the associated file from the specified URL.
|
static java.net.URL |
FileLocatorUtils.locateOrThrow(FileLocator locator) |
Tries to locate the file referenced by the passed in
FileLocator. |
void |
FileBased.read(java.io.Reader in) |
Reads the content of this object from the given reader.
|
void |
InputStreamSupport.read(java.io.InputStream in) |
Reads the content of this object from the specified
InputStream. |
void |
FileHandler.save() |
Saves the associated file to the current location set for this object.
|
void |
FileHandler.save(java.io.File file) |
Saves the associated file to the specified
File. |
void |
FileHandler.save(java.io.OutputStream out) |
Saves the associated file to the specified stream using the encoding
returned by
FileHandler.getEncoding(). |
void |
FileHandler.save(java.io.OutputStream out,
java.lang.String encoding) |
Saves the associated file to the specified stream using the specified
encoding.
|
void |
FileHandler.save(java.io.Writer out) |
Saves the associated file to the given
Writer. |
void |
FileHandler.save(java.lang.String fileName) |
Saves the associated file to the specified file name.
|
void |
FileHandler.save(java.net.URL url) |
Saves the associated file to the specified URL.
|
void |
FileBased.write(java.io.Writer out) |
Writes the content of this object to the given writer.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
PropertyListConfiguration.read(java.io.Reader in) |
|
void |
XMLPropertyListConfiguration.read(java.io.Reader in) |
|
void |
PropertyListConfiguration.write(java.io.Writer out) |
|
void |
XMLPropertyListConfiguration.write(java.io.Writer out) |
Copyright © 2001–2018. All rights reserved.