Package | Description |
---|---|
org.apache.avalon.framework.configuration |
Component configuration interfaces and XML-based implementations.
|
org.apache.avalon.framework.container |
Utilities supporting execution of component lifecycle stages.
|
org.apache.avalon.framework.parameters |
Interfaces supporting the supply of flat configuration information.
|
Modifier and Type | Interface and Description |
---|---|
interface |
MutableConfiguration
A read/write extension of the Configuration interface.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractConfiguration
This is an abstract
Configuration implementation that deals
with methods that can be abstracted away from underlying implementations. |
class |
DefaultConfiguration
This is the default
Configuration implementation. |
class |
DefaultImmutableConfiguration
An immutable implementation of the
Configuration interface. |
Modifier and Type | Field and Description |
---|---|
protected static Configuration[] |
DefaultConfiguration.EMPTY_ARRAY
An empty (length zero) array of configuration objects.
|
protected static Configuration[] |
DefaultImmutableConfiguration.EMPTY_ARRAY
An empty (length zero) array of configuration objects.
|
Modifier and Type | Method and Description |
---|---|
Configuration |
DefaultConfigurationBuilder.build(InputSource input)
Build a configuration object using an XML InputSource object
|
Configuration |
DefaultConfigurationBuilder.build(InputStream inputStream)
Build a configuration object using an InputStream.
|
Configuration |
DefaultConfigurationBuilder.build(InputStream inputStream,
String systemId)
Build a configuration object using an InputStream;
supplying a systemId to make messages about all
kinds of errors more meaningfull.
|
Configuration |
DefaultConfigurationBuilder.build(String uri)
Build a configuration object using an URI
|
Configuration |
DefaultConfigurationBuilder.buildFromFile(File file)
Build a configuration object from a file using a File object.
|
Configuration |
DefaultConfigurationBuilder.buildFromFile(String filename)
Build a configuration object from a file using a filename.
|
Configuration |
AbstractConfiguration.getChild(String name)
Return the first
Configuration object child of this
associated with the given name. |
Configuration |
Configuration.getChild(String child)
Return a new
Configuration instance encapsulating the
specified child node. |
Configuration |
AbstractConfiguration.getChild(String name,
boolean createNew)
Return the first
Configuration object child of this
associated with the given name. |
Configuration |
DefaultConfiguration.getChild(String name,
boolean createNew)
Return the first
Configuration object child of this
associated with the given name. |
Configuration |
DefaultImmutableConfiguration.getChild(String name,
boolean createNew)
Return the first
Configuration object child of this
associated with the given name. |
Configuration |
Configuration.getChild(String child,
boolean createNew)
Return a
Configuration instance encapsulating the specified
child node. |
Configuration[] |
DefaultConfiguration.getChildren()
Return an array of
Configuration
elements containing all node children. |
Configuration[] |
DefaultImmutableConfiguration.getChildren()
Return an array of
Configuration
elements containing all node children. |
Configuration[] |
Configuration.getChildren()
Return an
Array of Configuration
elements containing all node children. |
Configuration[] |
DefaultConfiguration.getChildren(String name)
Return an array of
Configuration objects
children of this associated with the given name. |
Configuration[] |
DefaultImmutableConfiguration.getChildren(String name)
Return an array of
Configuration objects
children of this associated with the given name. |
Configuration[] |
Configuration.getChildren(String name)
Return an
Array of Configuration
elements containing all node children with the specified name. |
Configuration |
NamespacedSAXConfigurationHandler.getConfiguration()
Get the configuration object that was built.
|
Configuration |
SAXConfigurationHandler.getConfiguration()
Get the configuration object that was built.
|
Configuration |
ConfigurationException.getOffendingConfiguration() |
static Configuration |
ConfigurationUtil.toConfiguration(Element element)
Convert a DOM Element tree into a configuration tree.
|
Modifier and Type | Method and Description |
---|---|
void |
MutableConfiguration.addAll(Configuration other)
Add all the attributes, children and value
from specified configuration element to current
configuration element.
|
void |
DefaultConfiguration.addAll(Configuration other)
Add all the attributes, children and value
from specified configuration element to current
configuration element.
|
void |
DefaultConfiguration.addAll(Configuration other,
boolean deepCopy)
Add all the attributes, children and value
from specified configuration element to current
configuration element.
|
void |
MutableConfiguration.addAllAttributes(Configuration other)
Add all attributes from specified configuration
element to current configuration element.
|
void |
DefaultConfiguration.addAllAttributes(Configuration other)
Add all attributes from specified configuration
element to current configuration element.
|
void |
MutableConfiguration.addAllChildren(Configuration other)
Add all child
Configuration objects from specified
configuration element to current configuration element. |
void |
DefaultConfiguration.addAllChildren(Configuration other)
Add all child
Configuration objects from specified
configuration element to current configuration element. |
void |
DefaultConfiguration.addAllChildren(Configuration other,
boolean deepCopy)
Add all child
Configuration objects from specified
configuration element to current configuration element. |
void |
MutableConfiguration.addChild(Configuration configuration)
Add a child
Configuration to this configuration element. |
void |
DefaultConfiguration.addChild(Configuration configuration)
Add a child
Configuration to this configuration element. |
void |
Configurable.configure(Configuration configuration)
Pass the
Configuration to the Configurable
class. |
static boolean |
ConfigurationUtil.equals(Configuration c1,
Configuration c2)
Test to see if two Configuration's can be considered the same.
|
void |
Reconfigurable.reconfigure(Configuration configuration)
Describe
reconfigure method here. |
void |
MutableConfiguration.removeChild(Configuration configuration)
Remove a child
Configuration to this configuration element. |
void |
DefaultConfiguration.removeChild(Configuration configuration)
Remove a child
Configuration to this configuration element. |
String |
DefaultConfigurationSerializer.serialize(Configuration source)
Serialize the configuration object to a string
|
void |
DefaultConfigurationSerializer.serialize(ContentHandler handler,
Configuration source)
Serialize the configuration to a ContentHandler
|
void |
DefaultConfigurationSerializer.serialize(OutputStream outputStream,
Configuration source)
Serialize the configuration object to an output stream.
|
void |
DefaultConfigurationSerializer.serialize(String uri,
Configuration source)
Serialize the configuration object to an output stream derived from an
URI.
|
protected void |
DefaultConfigurationSerializer.serializeElement(ContentHandler handler,
NamespaceSupport namespaceSupport,
Configuration element)
Serialize each Configuration element.
|
void |
DefaultConfigurationSerializer.serializeToFile(File file,
Configuration source)
Serialize the configuration object to a file using a File object.
|
void |
DefaultConfigurationSerializer.serializeToFile(String filename,
Configuration source)
Serialize the configuration object to a file using a filename.
|
static Element |
ConfigurationUtil.toElement(Configuration configuration)
Convert a configuration tree into a DOM Element tree.
|
static String |
ConfigurationUtil.toString(Configuration configuration)
Serialize the configuration object to a String.
|
Constructor and Description |
---|
ConfigurationException(Configuration config)
Construct a new
ConfigurationException instance. |
ConfigurationException(String message,
Configuration config)
Construct a new
ConfigurationException instance. |
ConfigurationException(String message,
Configuration config,
Throwable throwable)
Construct a new
ConfigurationException instance. |
DefaultConfiguration(Configuration config)
Shallow copy constructor, suitable for craeting a writable clone of
a read-only configuration.
|
DefaultConfiguration(Configuration config,
boolean deepCopy)
Copy constructor, to create a clone of another configuration.
|
DefaultImmutableConfiguration(Configuration config)
Deep copy constructor.
|
Modifier and Type | Method and Description |
---|---|
static void |
ContainerUtil.configure(Object object,
Configuration configuration)
Configure specified object if it implements the
Configurable interface. |
Modifier and Type | Method and Description |
---|---|
static Parameters |
Parameters.fromConfiguration(Configuration configuration)
Create a
Parameters object from a Configuration
object. |
static Parameters |
Parameters.fromConfiguration(Configuration configuration,
String elementName)
Create a
Parameters object from a Configuration
object using the supplied element name. |
Copyright © 2023. All rights reserved.