Uses of Class
org.apache.commons.configuration2.ex.ConfigurationException
Package
Description
The Configuration main package.
This package contains the implementations of configuration builder classes used to create new
Configuration
objects.
A package containing the implementation of the builder for combined configurations.
This package defines a fluent API for setting up fully configured configuration builders.
A package with classes related to I/O operations.
Configuration classes supporting NeXT / OpenStep /GNUStep style configuration.
-
Uses of ConfigurationException in org.apache.commons.configuration2
Modifier and TypeFieldDescriptionstatic final ConfigurationConsumer<ConfigurationException>
PropertiesConfiguration.DEFAULT_INCLUDE_LISTENER
Defines default error handling for the special"include"
key by throwing the given exception.static final ConfigurationConsumer<ConfigurationException>
PropertiesConfiguration.NOOP_INCLUDE_LISTENER
Defines error handling as a noop for the special"include"
key.Modifier and TypeMethodDescriptionPropertiesConfiguration.getIncludeListener()
Gets the current include listener, never null.Modifier and TypeMethodDescriptionvoid
PropertiesConfiguration.setIncludeListener
(ConfigurationConsumer<ConfigurationException> includeListener) Sets the current include listener, may not be null.Modifier and TypeMethodDescriptionvoid
Performs this operation on the given argument.protected Transformer
XMLConfiguration.createTransformer()
Creates and initializes the transformer used for save operations.void
void
PropertiesConfigurationLayout.load
(PropertiesConfiguration config, Reader reader) Reads a properties file and stores its internal structure.void
Parses a DOM element containing the properties.void
Load the configuration from the given reader.void
JSONConfiguration.read
(InputStream in) Loads the configuration from the given input stream.void
void
void
Reads the content of this object from the given reader.void
XMLConfiguration.read
(InputStream in) Loads the configuration from the given input stream.void
Loads the configuration from the given reader.void
void
YAMLConfiguration.read
(InputStream in) Loads the configuration from the given input stream.void
YAMLConfiguration.read
(InputStream in, org.yaml.snakeyaml.LoaderOptions options) void
void
void
PropertiesConfigurationLayout.save
(PropertiesConfiguration config, Writer writer) Writes the properties file to the given writer, preserving as much of its structure as possible.static void
SystemConfiguration.setSystemProperties
(String fileName) Sets system properties from a file specified by its file name.static void
SystemConfiguration.setSystemProperties
(String basePath, 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
Save the configuration to the specified writer.void
void
void
Writes the content of this object to the given writer.void
Saves the configuration to the specified writer.void
XMLConfiguration.write
(Writer writer, Transformer transformer) Saves the configuration to the specified writer.void
void
ModifierConstructorDescriptionXMLPropertiesConfiguration
(Element element) Creates and loads the XML properties from the specified DOM node. -
Uses of ConfigurationException in org.apache.commons.configuration2.builder
Modifier and TypeMethodDescriptionPropertiesBuilderParametersImpl.setIncludeListener
(ConfigurationConsumer<ConfigurationException> includeListener) default T
PropertiesBuilderProperties.setIncludeListener
(ConfigurationConsumer<ConfigurationException> includeListener) Sets the current include listener, may be null.Modifier and TypeMethodDescriptionDefaultReloadingDetectorFactory.createReloadingDetector
(FileHandler handler, FileBasedBuilderParametersImpl params) ReloadingDetectorFactory.createReloadingDetector
(FileHandler handler, FileBasedBuilderParametersImpl params) Creates a newReloadingDetector
object based on the passed in parameters.protected ReloadingDetector
ReloadingFileBasedConfigurationBuilder.createReloadingDetector
(FileHandler handler, FileBasedBuilderParametersImpl fbparams) Creates aReloadingDetector
which monitors the passed inFileHandler
.protected T
BasicConfigurationBuilder.createResult()
Creates a new, initialized result object.protected BeanDeclaration
BasicConfigurationBuilder.createResultDeclaration
(Map<String, Object> params) Creates a newBeanDeclaration
which is used for creating new result objects dynamically.protected T
BasicConfigurationBuilder.createResultInstance()
Creates the new, uninitialized result object.BasicConfigurationBuilder.getConfiguration()
Gets the configuration provided by this builder.ConfigurationBuilder.getConfiguration()
Gets the configuration provided by this builder.protected final BeanDeclaration
BasicConfigurationBuilder.getResultDeclaration()
Gets theBeanDeclaration
that is used to create and initialize result objects.protected void
FileBasedConfigurationBuilder.initFileHandler
(FileHandler handler) Initializes the new currentFileHandler
.protected void
ReloadingFileBasedConfigurationBuilder.initFileHandler
(FileHandler handler) Initializes the new currentFileHandler
.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. -
Uses of ConfigurationException in org.apache.commons.configuration2.builder.combined
Modifier and TypeMethodDescriptionprotected void
CombinedConfigurationBuilder.configureEntityResolver
(HierarchicalConfiguration<?> config, XMLBuilderParametersImpl xmlParams) Creates and initializes a defaultEntityResolver
if the definition configuration contains a corresponding declaration.protected FileBasedConfigurationBuilder<T>
MultiFileConfigurationBuilder.createInitializedManagedBuilder
(String fileName, Map<String, Object> params) Creates a fully initialized builder for a managed configuration.protected FileBasedConfigurationBuilder<T>
MultiFileConfigurationBuilder.createManagedBuilder
(String fileName, Map<String, Object> params) Creates a builder for a managed configuration.protected FileBasedConfigurationBuilder<T>
ReloadingMultiFileConfigurationBuilder.createManagedBuilder
(String fileName, Map<String, Object> params) Creates a builder for a managed configuration.protected ReloadingController
ReloadingCombinedConfigurationBuilder.createReloadingController()
Creates theReloadingController
for this builder.protected BeanDeclaration
CombinedConfigurationBuilder.createResultDeclaration
(Map<String, Object> params) Creates a newBeanDeclaration
which is used for creating new result objects dynamically.protected String
BaseConfigurationBuilderProvider.determineBuilderClass
(ConfigurationDeclaration decl) Determines the name of the class to be used for a new builder instance.protected String
BaseConfigurationBuilderProvider.determineConfigurationClass
(ConfigurationDeclaration decl, Collection<BuilderParameters> params) Determines the name of the configuration class produced by the builder.protected String
FileExtensionConfigurationBuilderProvider.determineConfigurationClass
(ConfigurationDeclaration decl, Collection<BuilderParameters> params) Determines the name of the configuration class produced by the builder.MultiFileConfigurationBuilder.getConfiguration()
Gets the configuration provided by this builder.ReloadingCombinedConfigurationBuilder.getConfiguration()
Gets the configuration provided by this builder.ConfigurationBuilder<? extends Configuration>
BaseConfigurationBuilderProvider.getConfigurationBuilder
(ConfigurationDeclaration decl) Gets the builder for the configuration source managed by this provider.ConfigurationBuilder<? extends Configuration>
ConfigurationBuilderProvider.getConfigurationBuilder
(ConfigurationDeclaration decl) Gets the builder for the configuration source managed by this provider.ConfigurationBuilder<? extends Configuration>
MultiFileConfigurationBuilderProvider.getConfigurationBuilder
(ConfigurationDeclaration decl) Gets the builder for the configuration source managed by this provider.ConfigurationBuilder<? extends HierarchicalConfiguration<?>>
CombinedConfigurationBuilder.getDefinitionBuilder()
Gets theConfigurationBuilder
which creates the definition configuration.protected HierarchicalConfiguration<?>
CombinedConfigurationBuilder.getDefinitionConfiguration()
Gets the configuration containing the definition of the combined configuration to be created.MultiFileConfigurationBuilder.getManagedBuilder()
Gets the managedFileBasedConfigurationBuilder
for the current file name pattern.ConfigurationBuilder<? extends Configuration>
CombinedConfigurationBuilder.getNamedBuilder
(String name) Gets the configuration builder with the given name.protected FileSystem
CombinedConfigurationBuilder.initFileSystem
(HierarchicalConfiguration<?> config) Creates and initializes a defaultFileSystem
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, 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 customLookup
objects that might be declared in the definition configuration.protected ConfigurationBuilder<? extends HierarchicalConfiguration<?>>
CombinedConfigurationBuilder.setupDefinitionBuilder
(Map<String, Object> params) Obtains theConfigurationBuilder
object which provides access to the configuration containing the definition of the combined configuration to create. -
Uses of ConfigurationException in org.apache.commons.configuration2.builder.fluent
Modifier and TypeMethodDescriptionCreates aCombinedConfiguration
instance from the content of the given file.Creates aCombinedConfiguration
instance from the content of the file identified by the given path.Creates aCombinedConfiguration
instance from the content of the given URL.<T extends FileBasedConfiguration>
TCreates an instance of the specified file-based configuration class from the content of the given file.<T extends FileBasedConfiguration>
TCreates an instance of the specified file-based configuration class from the content of the file identified by the given path.<T extends FileBasedConfiguration>
TCreates an instance of the specified file-based configuration class from the content of the given URL.Creates aINIConfiguration
instance from the content of the given file.Creates aINIConfiguration
instance from the content of the file identified by the given path.Creates aINIConfiguration
instance from the content of the given URL.Configurations.properties
(File file) Creates aPropertiesConfiguration
instance from the content of the given file.Configurations.properties
(String path) Creates aPropertiesConfiguration
instance from the content of the file identified by the given path.Configurations.properties
(URL url) Creates aPropertiesConfiguration
instance from the content of the given URL.Creates aXMLConfiguration
instance from the content of the given file.Creates aXMLConfiguration
instance from the content of the file identified by the given path.Creates aXMLConfiguration
instance from the content of the given URL. -
Uses of ConfigurationException in org.apache.commons.configuration2.io
Modifier and TypeMethodDescriptionDefaultFileSystem.getInputStream
(URL url) DefaultFileSystem.getInputStream
(URL url, URLConnectionOptions urlConnectionOptions) abstract InputStream
FileSystem.getInputStream
(URL url) FileSystem.getInputStream
(URL url, URLConnectionOptions urlConnectionOptions) Not abstract for binary compatibility.VFSFileSystem.getInputStream
(URL url) DefaultFileSystem.getOutputStream
(File file) DefaultFileSystem.getOutputStream
(URL url) abstract OutputStream
FileSystem.getOutputStream
(File file) abstract OutputStream
FileSystem.getOutputStream
(URL url) VFSFileSystem.getOutputStream
(URL url) void
FileHandler.load()
Loads the associated file from the underlying location.void
Loads the associated file from the specifiedFile
.void
FileHandler.load
(InputStream in) Loads the associated file from the specified stream, using the encoding returned byFileHandler.getEncoding()
.void
FileHandler.load
(InputStream in, String encoding) Loads the associated file from the specified stream, using the specified encoding.void
Loads the associated file from the specified reader.void
Loads the associated file from the given file name.void
Loads the associated file from the specified URL.static URL
FileLocatorUtils.locateOrThrow
(FileLocator locator) Tries to locate the file referenced by the passed inFileLocator
.void
Reads the content of this object from the given reader.void
InputStreamSupport.read
(InputStream in) Reads the content of this object from the specifiedInputStream
.void
FileHandler.save()
Saves the associated file to the current location set for this object.void
Saves the associated file to the specifiedFile
.void
FileHandler.save
(OutputStream out) Saves the associated file to the specified stream using the encoding returned byFileHandler.getEncoding()
.void
FileHandler.save
(OutputStream out, String encoding) Saves the associated file to the specified stream using the specified encoding.void
Saves the associated file to the givenWriter
.void
Saves the associated file to the specified file name.void
Saves the associated file to the specified URL.void
Writes the content of this object to the given writer. -
Uses of ConfigurationException in org.apache.commons.configuration2.plist