Uses of Class
org.apache.commons.configuration2.ex.ConfigurationException
Packages that use 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
Fields in org.apache.commons.configuration2 with type parameters of type ConfigurationExceptionModifier and TypeFieldDescriptionstatic final ConfigurationConsumer<ConfigurationException> PropertiesConfiguration.DEFAULT_INCLUDE_LISTENERDefines default error handling for the special"include"key by throwing the given exception.PropertiesConfiguration.includeListenerThe include listener for the special"include"key.static final ConfigurationConsumer<ConfigurationException> PropertiesConfiguration.NOOP_INCLUDE_LISTENERDefines error handling as a noop for the special"include"key.Methods in org.apache.commons.configuration2 that return types with arguments of type ConfigurationExceptionModifier and TypeMethodDescriptionPropertiesConfiguration.getIncludeListener()Gets the current include listener, never null.Method parameters in org.apache.commons.configuration2 with type arguments of type ConfigurationExceptionModifier and TypeMethodDescriptionvoidPropertiesConfiguration.setIncludeListener(ConfigurationConsumer<ConfigurationException> includeListener) Sets the current include listener, may not be null.Methods in org.apache.commons.configuration2 that throw ConfigurationExceptionModifier and TypeMethodDescriptionvoidPerforms this operation on the given argument.private static DocumentXMLDocumentHelper.copyDocument(Document doc) Creates a copy of the specified document.XMLDocumentHelper.createCopy()Creates a copy of this object.private DocumentXMLConfiguration.createDocument()Creates a DOM document from the internal tree of configuration nodes.(package private) static DocumentBuilderXMLDocumentHelper.createDocumentBuilder(DocumentBuilderFactory factory) Creates a newDocumentBuilderusing the specified factory.protected TransformerXMLConfiguration.createTransformer()Creates and initializes the transformer used for save operations.static TransformerXMLDocumentHelper.createTransformer()Creates a newTransformerobject.(package private) static TransformerXMLDocumentHelper.createTransformer(TransformerFactory factory) Creates aTransformerusing the specified factory.private FileBasedPatternSubtreeConfigurationWrapper.fetchFileBased()Returns the wrapped configuration as aFileBasedobject.static XMLDocumentHelperXMLDocumentHelper.forNewDocument(String rootElementName) Creates a new instance ofXMLDocumentHelperand initializes it with a newly created, emptyDocument.static XMLDocumentHelperXMLDocumentHelper.forSourceDocument(Document srcDoc) Creates a new instance ofXMLDocumentHelperand initializes it with a source document.voidPropertiesConfigurationLayout.load(PropertiesConfiguration config, Reader reader) Reads a properties file and stores its internal structure.private voidXMLConfiguration.load(InputSource source) Loads a configuration file from the specified input source.voidParses a DOM element containing the properties.private voidPropertiesConfiguration.loadIncludeFile(String fileName, boolean optional, Deque<URL> seenStack) Helper method for loading an included properties file.(package private) booleanPropertiesConfiguration.propertyLoaded(String key, String value, Deque<URL> seenStack) This method is invoked by the associatedPropertiesConfigurationLayoutobject for each property definition detected in the parsed properties file.voidLoad the configuration from the given reader.voidJSONConfiguration.read(InputStream in) Loads the configuration from the given input stream.voidvoidvoidReads the content of this object from the given reader.voidXMLConfiguration.read(InputStream in) Loads the configuration from the given input stream.voidLoads the configuration from the given reader.void(package private) static voidAbstractYAMLBasedConfiguration.rethrowException(Exception e) Internal helper method to wrap an exception in aConfigurationException.voidPropertiesConfigurationLayout.save(PropertiesConfiguration config, Writer writer) Writes the properties file to the given writer, preserving as much of its structure as possible.static voidSystemConfiguration.setSystemProperties(String fileName) Sets system properties from a file specified by its file name.static voidSystemConfiguration.setSystemProperties(String basePath, String fileName) Sets system properties from a file specified using its base path and file name.static voidXMLDocumentHelper.transform(Transformer transformer, Source source, Result result) Performs an XSL transformation on the passed in operands.voidXMLConfiguration.validate()Validate the document against the Schema.voidSave the configuration to the specified writer.voidvoidvoidWrites the content of this object to the given writer.voidSaves the configuration to the specified writer.voidXMLConfiguration.write(Writer writer, Transformer transformer) Saves the configuration to the specified writer.voidConstructors in org.apache.commons.configuration2 that throw ConfigurationExceptionModifierConstructorDescriptionXMLPropertiesConfiguration(Element element) Creates and loads the XML properties from the specified DOM node. -
Uses of ConfigurationException in org.apache.commons.configuration2.builder
Method parameters in org.apache.commons.configuration2.builder with type arguments of type ConfigurationExceptionModifier and TypeMethodDescriptionPropertiesBuilderParametersImpl.setIncludeListener(ConfigurationConsumer<ConfigurationException> includeListener) default TPropertiesBuilderProperties.setIncludeListener(ConfigurationConsumer<ConfigurationException> includeListener) Sets the current include listener, may be null.Methods in org.apache.commons.configuration2.builder that throw ConfigurationExceptionModifier and TypeMethodDescriptionDefaultReloadingDetectorFactory.createReloadingDetector(FileHandler handler, FileBasedBuilderParametersImpl params) ReloadingDetectorFactory.createReloadingDetector(FileHandler handler, FileBasedBuilderParametersImpl params) Creates a newReloadingDetectorobject based on the passed in parameters.protected ReloadingDetectorReloadingFileBasedConfigurationBuilder.createReloadingDetector(FileHandler handler, FileBasedBuilderParametersImpl fbparams) Creates aReloadingDetectorwhich monitors the passed inFileHandler.protected TBasicConfigurationBuilder.createResult()Creates a new, initialized result object.protected BeanDeclarationBasicConfigurationBuilder.createResultDeclaration(Map<String, Object> params) Creates a newBeanDeclarationwhich is used for creating new result objects dynamically.protected TBasicConfigurationBuilder.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 BeanDeclarationBasicConfigurationBuilder.getResultDeclaration()Gets theBeanDeclarationthat is used to create and initialize result objects.private ObjectBuilderConfigurationWrapperFactory.BuilderConfigurationWrapperInvocationHandler.handleConfigurationInvocation(Method method, Object[] args) Handles a method invocation on the associated builder's configuration object.protected voidFileBasedConfigurationBuilder.initFileHandler(FileHandler handler) Initializes the new currentFileHandler.protected voidReloadingFileBasedConfigurationBuilder.initFileHandler(FileHandler handler) Initializes the new currentFileHandler.protected voidBasicConfigurationBuilder.initResultInstance(T obj) Initializes a newly created result object.protected voidFileBasedConfigurationBuilder.initResultInstance(T obj) Initializes a newly created result object.BuilderConfigurationWrapperFactory.BuilderConfigurationWrapperInvocationHandler.invoke(Object proxy, Method method, Object[] args) Handles method invocations.voidFileBasedConfigurationBuilder.save()Convenience method which saves the associated configuration. -
Uses of ConfigurationException in org.apache.commons.configuration2.builder.combined
Methods in org.apache.commons.configuration2.builder.combined that throw ConfigurationExceptionModifier and TypeMethodDescriptionprivate voidCombinedConfigurationBuilder.ConfigurationSourceData.addChildConfiguration(CombinedConfiguration ccResult, ConfigurationDeclaration decl, ConfigurationBuilder<? extends Configuration> builder) Creates a new configuration using the specified builder and adds it to the resulting combined configuration.protected voidCombinedConfigurationBuilder.configureEntityResolver(HierarchicalConfiguration<?> config, XMLBuilderParametersImpl xmlParams) Creates and initializes a defaultEntityResolverif the definition configuration contains a corresponding declaration.List<ConfigurationBuilder<? extends Configuration>> CombinedConfigurationBuilder.ConfigurationSourceData.createAndAddConfigurations(CombinedConfiguration ccResult, List<ConfigurationDeclaration> srcDecl, List<ConfigurationBuilder<? extends Configuration>> builders) Processes the declaration of configuration builder providers, creates the corresponding builder if necessary, obtains configurations, and adds them to the specified result configuration.private ConfigurationBuilder<? extends Configuration> CombinedConfigurationBuilder.ConfigurationSourceData.createConfigurationBuilder(ConfigurationDeclaration decl) Creates a configuration builder based on a source declaration in the definition configuration.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 ReloadingControllerReloadingCombinedConfigurationBuilder.createReloadingController()Creates theReloadingControllerfor this builder.protected BeanDeclarationCombinedConfigurationBuilder.createResultDeclaration(Map<String, Object> params) Creates a newBeanDeclarationwhich is used for creating new result objects dynamically.CombinedConfigurationBuilder.createSourceData()Creates the data object for configuration sources and the corresponding builders.protected StringBaseConfigurationBuilderProvider.determineBuilderClass(ConfigurationDeclaration decl) Determines the name of the class to be used for a new builder instance.protected StringBaseConfigurationBuilderProvider.determineConfigurationClass(ConfigurationDeclaration decl, Collection<BuilderParameters> params) Determines the name of the configuration class produced by the builder.protected StringFileExtensionConfigurationBuilderProvider.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.MultiFileConfigurationBuilderProvider.WrapperBuilder.getConfiguration()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 theConfigurationBuilderwhich 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 managedFileBasedConfigurationBuilderfor the current file name pattern.ConfigurationBuilder<? extends Configuration> CombinedConfigurationBuilder.getNamedBuilder(String name) Gets the configuration builder with the given name.CombinedConfigurationBuilder.getSourceData()Obtains the data object for the configuration sources and the corresponding builders.private voidCombinedConfigurationBuilder.initDefaultBasePath()Initializes the default base path for all file-based child configuration sources.protected FileSystemCombinedConfigurationBuilder.initFileSystem(HierarchicalConfiguration<?> config) Creates and initializes a defaultFileSystemif the definition configuration contains a corresponding declaration.voidCombinedConfigurationBuilder.ConfigurationSourceData.initFromDefinitionConfiguration(HierarchicalConfiguration<?> config) Initializes this object from the specified definition configuration.protected voidCombinedConfigurationBuilder.initResultInstance(CombinedConfiguration result) Initializes a newly created result object.protected voidReloadingCombinedConfigurationBuilder.initResultInstance(CombinedConfiguration result) Initializes a newly created result object.protected voidCombinedConfigurationBuilder.initSystemProperties(HierarchicalConfiguration<?> config, String basePath) Handles a file with system properties that may be defined in the definition configuration.protected voidCombinedConfigurationBuilder.registerConfiguredLookups(HierarchicalConfiguration<?> defConfig, Configuration resultConfig) Processes customLookupobjects that might be declared in the definition configuration.private voidCombinedConfigurationBuilder.setUpCurrentXMLParameters()Sets up an XML parameters object which is used to store properties related to XML and file-based configurations during creation of the result configuration.protected ConfigurationBuilder<? extends HierarchicalConfiguration<?>> CombinedConfigurationBuilder.setupDefinitionBuilder(Map<String, Object> params) Obtains theConfigurationBuilderobject 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
Methods in org.apache.commons.configuration2.builder.fluent that throw ConfigurationExceptionModifier and TypeMethodDescriptionCreates aCombinedConfigurationinstance from the content of the given file.Creates aCombinedConfigurationinstance from the content of the file identified by the given path.Creates aCombinedConfigurationinstance 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 aINIConfigurationinstance from the content of the given file.Creates aINIConfigurationinstance from the content of the file identified by the given path.Creates aINIConfigurationinstance from the content of the given URL.Configurations.properties(File file) Creates aPropertiesConfigurationinstance from the content of the given file.Configurations.properties(String path) Creates aPropertiesConfigurationinstance from the content of the file identified by the given path.Configurations.properties(URL url) Creates aPropertiesConfigurationinstance from the content of the given URL.Creates aXMLConfigurationinstance from the content of the given file.Creates aXMLConfigurationinstance from the content of the file identified by the given path.Creates aXMLConfigurationinstance from the content of the given URL. -
Uses of ConfigurationException in org.apache.commons.configuration2.io
Methods in org.apache.commons.configuration2.io that throw ConfigurationExceptionModifier and TypeMethodDescriptionprivate voidFileHandler.checkContent()Checks whether a content object is available.private FileLocatorFileHandler.checkContentAndGetLocator()Checks whether a content object is available and returns the currentFileLocator.private voidDefaultFileSystem.createPath(File file) Create the path to the specified file.DefaultFileSystem.getInputStream(URL url) DefaultFileSystem.getInputStream(URL url, URLConnectionOptions urlConnectionOptions) abstract InputStreamFileSystem.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 OutputStreamFileSystem.getOutputStream(File file) abstract OutputStreamFileSystem.getOutputStream(URL url) VFSFileSystem.getOutputStream(URL url) voidFileHandler.load()Loads the associated file from the underlying location.voidLoads the associated file from the specifiedFile.voidFileHandler.load(InputStream in) Loads the associated file from the specified stream, using the encoding returned byFileHandler.getEncoding().voidFileHandler.load(InputStream in, String encoding) Loads the associated file from the specified stream, using the specified encoding.private voidFileHandler.load(InputStream in, FileLocator locator) Internal helper method for loading a file from the given input stream.voidLoads the associated file from the specified reader.voidLoads the associated file from the given file name.private voidFileHandler.load(String fileName, FileLocator locator) Internal helper method for loading a file from a file name.voidLoads the associated file from the specified URL.private voidFileHandler.load(URL url, FileLocator locator) Internal helper method for loading a file from the given URL.private voidFileHandler.load(FileLocator locator) Internal helper method for loading the associated file from the location specified in the givenFileLocator.private voidFileHandler.loadFromReader(Reader in) Internal helper method for loading a file from the given reader.private voidFileHandler.loadFromStream(InputStream in, String encoding, URL url) Internal helper method for loading a file from an input stream.private voidFileHandler.loadFromStreamDirectly(InputStream in) Loads data from an input stream if the associatedFileBasedobject implements theInputStreamSupportinterface.private voidFileHandler.loadFromTransformedStream(InputStream in, String encoding) Internal helper method for transforming an input stream to a reader and reading its content.static URLFileLocatorUtils.locateOrThrow(FileLocator locator) Tries to locate the file referenced by the passed inFileLocator.voidReads the content of this object from the given reader.voidInputStreamSupport.read(InputStream in) Reads the content of this object from the specifiedInputStream.voidFileHandler.save()Saves the associated file to the current location set for this object.voidSaves the associated file to the specifiedFile.private voidFileHandler.save(File file, FileLocator locator) Internal helper method for saving data to the givenFile.voidFileHandler.save(OutputStream out) Saves the associated file to the specified stream using the encoding returned byFileHandler.getEncoding().voidFileHandler.save(OutputStream out, String encoding) Saves the associated file to the specified stream using the specified encoding.private voidFileHandler.save(OutputStream out, FileLocator locator) Internal helper method for saving a file to the given output stream.voidSaves the associated file to the givenWriter.voidSaves the associated file to the specified file name.private voidFileHandler.save(String fileName, FileLocator locator) Internal helper method for saving data to the given file name.voidSaves the associated file to the specified URL.private voidFileHandler.save(URL url, FileLocator locator) Internal helper method for saving data to the given URL.private voidFileHandler.save(FileLocator locator) Internal helper method for saving data to the internal location stored for this object.private voidFileHandler.saveToStream(OutputStream out, String encoding, URL url) Internal helper method for saving a file to the given stream.private voidFileHandler.saveToWriter(Writer out) Internal helper method for saving a file into the given writer.voidWrites the content of this object to the given writer. -
Uses of ConfigurationException in org.apache.commons.configuration2.plist
Methods in org.apache.commons.configuration2.plist that throw ConfigurationException