Avalon Framework Implementation 4.3.1 · org.apache.avalon.framework.configuration.DefaultConfiguration

Modifier and Type	Field and Description
protected static final Configuration[]	EMPTY_ARRAY An empty (length zero) array of configuration objects.
private HashMap<K, V>	m_attributes
private ArrayList<E>	m_children
private final String	m_location
private final String	m_name
private final String	m_namespace
private final String	m_prefix
private boolean	m_readOnly
private String	m_value

Access	Constructor and Description
public	DefaultConfiguration(Configuration the `Configuration` to copy config, boolean true will cause clones of the children to be added, false will add the original instances and is thus faster. deepCopy) Copy constructor, to create a clone of another configuration.
public	DefaultConfiguration(Configuration the `Configuration` to copy config) Shallow copy constructor, suitable for craeting a writable clone of a read-only configuration.
public	DefaultConfiguration(final String a `String` value name) Create a new `DefaultConfiguration` instance.
public	DefaultConfiguration(final String a `String` value name, final String a `String` value location) Create a new `DefaultConfiguration` instance.
public	DefaultConfiguration(final String config node name name, final String Builder-specific locator string location, final String Namespace string (typically a URI). Should not be null; use "" if no namespace. ns, final String A short string prefixed to element names, associating elements with a longer namespace string. Should not be null; use "" if no namespace. prefix) Create a new `DefaultConfiguration` instance.

Method Summary

Modifier and Type	Method and Description
public void	addAll(final Configuration the `Configuration` element other, final boolean true will cause clones of the children to be added, false will add the original instances and is thus faster. throws ConfigurationException If there are any problems cloning the children. deepCopy) Add all the attributes, children and value from specified configuration element to current configuration element.
public void	addAll(final Configuration the `Configuration` element other) Implements org.apache.avalon.framework.configuration.MutableConfiguration.addAll. Add all the attributes, children and value from specified configuration element to current configuration element.
public void	addAllAttributes(final Configuration the `Configuration` element other) Implements org.apache.avalon.framework.configuration.MutableConfiguration.addAllAttributes. Add all attributes from specified configuration element to current configuration element.
public void	addAllChildren(final Configuration the other `Configuration` value throws ConfigurationException If there are any problems cloning the children. other, final boolean true will cause clones of the children to be added, false will add the original instances and is thus faster. deepCopy) Add all child `Configuration` objects from specified configuration element to current configuration element.
public void	addAllChildren(final Configuration the other `Configuration` value other) Implements org.apache.avalon.framework.configuration.MutableConfiguration.addAllChildren. Add all child `Configuration` objects from specified configuration element to current configuration element.
public String	Returns: a `String` value addAttribute(final String a `String` value name, String a `String` value value) Deprecated Use setAttribute() instead Add an attribute to this configuration element, returning its old value or null.
public void	addChild(final Configuration a `Configuration` value configuration) Implements org.apache.avalon.framework.configuration.MutableConfiguration.addChild. Add a child `Configuration` to this configuration element.
public void	appendValueData(final String a `String` value value) Deprecated Use setValue() instead Append data to the value of this configuration element.
private boolean	check(Object one, Object two)
protected final void	checkWriteable() heck if this configuration is writeable.
public boolean	Returns: `true` if they are the same. equals(Object The other configuration other) Overrides java.lang.Object.equals. Compare if this configuration is equal to another.
public String	Returns: a `String` value getAttribute(final String a `String` value name) Implements org.apache.avalon.framework.configuration.Configuration.getAttribute. Returns the value of the attribute specified by its name as a `String`.
public String[]	Returns: a `String[]` value getAttributeNames() Implements org.apache.avalon.framework.configuration.Configuration.getAttributeNames. Return an array of all attribute names.
public Configuration	Returns: a `Configuration` value getChild(final String a `String` value name, final boolean a `boolean` value createNew) Overrides org.apache.avalon.framework.configuration.AbstractConfiguration.getChild. Implements org.apache.avalon.framework.configuration.Configuration.getChild. Return the first `Configuration` object child of this associated with the given name.
public int	Returns: an `int` value getChildCount() Return count of children.
public Configuration[]	Returns: The child nodes with name getChildren() Implements org.apache.avalon.framework.configuration.Configuration.getChildren. Return an array of `Configuration` elements containing all node children.
public Configuration[]	Returns: a `Configuration[]` value getChildren(final String The name of the required children `Configuration`. name) Implements org.apache.avalon.framework.configuration.Configuration.getChildren. Return an array of `Configuration` objects children of this associated with the given name.
public String	Returns: a `String` value getLocation() Implements org.apache.avalon.framework.configuration.Configuration.getLocation. Returns a description of location of element.
public MutableConfiguration	getMutableChild(final String name) Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChild. Equivalent to `getMutableChild( name, true )`
public MutableConfiguration	getMutableChild(final String the name of the child. name, boolean set to true to create the child node if it doesn't exist. autoCreate) Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChild. Gets a child node of this configuration.
public MutableConfiguration[]	getMutableChildren() Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChildren. Returns an array of mutable children.
public MutableConfiguration[]	getMutableChildren(final String name) Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChildren. Returns an array of mutable children with the given name.
public String	Returns: a `String` value getName() Implements org.apache.avalon.framework.configuration.Configuration.getName. Returns the name of this configuration element.
public String	Returns: a `String` value getNamespace() Implements org.apache.avalon.framework.configuration.Configuration.getNamespace. Returns the namespace of this configuration element
protected String	Returns: a `String` value getPrefix() Implements abstract org.apache.avalon.framework.configuration.AbstractConfiguration.getPrefix. Returns the prefix of the namespace
public String	Returns: a `String` value getValue(final String the default value to return if value malformed or empty defaultValue) Overrides org.apache.avalon.framework.configuration.AbstractConfiguration.getValue. Implements org.apache.avalon.framework.configuration.Configuration.getValue. Returns the value of the configuration element as a `String`.
public String	Returns: a `String` value getValue() Implements org.apache.avalon.framework.configuration.Configuration.getValue. Returns the value of the configuration element as a `String`.
public int	Returns: the hashcode. hashCode() Overrides java.lang.Object.hashCode. Obtaine the hashcode for this configuration.
protected final boolean	isReadOnly() Returns true iff this DefaultConfiguration has been made read-only.
public void	makeReadOnly() Make this configuration read-only.
public void	removeChild(final Configuration a `Configuration` value configuration) Implements org.apache.avalon.framework.configuration.MutableConfiguration.removeChild. Remove a child `Configuration` to this configuration element.
public void	setAttribute(final String name of the attribute to set name, final String a `String` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute. Set the value of the specified attribute to the specified string.
public void	setAttribute(final String name of the attribute to set name, final int an `int` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute. Set the value of the specified attribute to the specified int.
public void	setAttribute(final String name of the attribute to set name, final long an `long` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute. Set the value of the specified attribute to the specified long.
public void	setAttribute(final String name of the attribute to set name, final boolean an `boolean` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute. Set the value of the specified attribute to the specified boolean.
public void	setAttribute(final String name of the attribute to set name, final float an `float` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute. Set the value of the specified attribute to the specified float.
public void	setAttribute(final String name of the attribute to set name, final double an `double` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute. Set the value of the specified attribute to the specified double.
public void	setValue(final String a `String` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue. Set the value of this `Configuration` object to the specified string.
public void	setValue(final int a `int` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue. Set the value of this `Configuration` object to the specified int.
public void	setValue(final long a `long` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue. Set the value of this `Configuration` object to the specified long.
public void	setValue(final boolean a `boolean` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue. Set the value of this `Configuration` object to the specified boolean.
public void	setValue(final float a `float` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue. Set the value of this `Configuration` object to the specified float.
public void	setValue(final double a `double` value value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue. Set the value of this `Configuration` object to the specified double.
private MutableConfiguration	toMutable(Configuration child) Convenience function to convert a child to a mutable configuration.

EMPTY_ARRAY	back to summary
protected static final Configuration[] EMPTY_ARRAY An empty (length zero) array of configuration objects.

m_attributes	back to summary
private HashMap<K, V> m_attributes

m_children	back to summary
private ArrayList<E> m_children

m_location	back to summary
private final String m_location

m_name	back to summary
private final String m_name

m_namespace	back to summary
private final String m_namespace

m_prefix	back to summary
private final String m_prefix

m_readOnly	back to summary
private boolean m_readOnly

m_value	back to summary
private String m_value

DefaultConfiguration	back to summary
public DefaultConfiguration(Configuration config, boolean deepCopy) throws ConfigurationException Copy constructor, to create a clone of another configuration. To modify children, use `getChild()`, `removeChild()` and `addChild()`. Parameters config:Configuration the `Configuration` to copy deepCopy:boolean true will cause clones of the children to be added, false will add the original instances and is thus faster. Exceptions ConfigurationException: if an error occurs when copying

DefaultConfiguration	back to summary
public DefaultConfiguration(Configuration config) throws ConfigurationException Shallow copy constructor, suitable for craeting a writable clone of a read-only configuration. To modify children, use `getChild()`, `removeChild()` and `addChild()`. Parameters config:Configuration the `Configuration` to copy Exceptions ConfigurationException: if an error occurs when copying

DefaultConfiguration	back to summary
public DefaultConfiguration(final String name) Create a new `DefaultConfiguration` instance. Parameters name:String a `String` value

DefaultConfiguration	back to summary
public DefaultConfiguration(final String name, final String location) Create a new `DefaultConfiguration` instance. Parameters name:String a `String` value location:String a `String` value

DefaultConfiguration	back to summary
public DefaultConfiguration(final String name, final String location, final String ns, final String prefix) Create a new `DefaultConfiguration` instance. Parameters name:String config node name location:String Builder-specific locator string ns:String Namespace string (typically a URI). Should not be null; use "" if no namespace. prefix:String A short string prefixed to element names, associating elements with a longer namespace string. Should not be null; use "" if no namespace. Since 4.1

Method Detail

addAll back to summary

addAll	back to summary
public void addAll(final Configuration other, final boolean deepCopy) throws ConfigurationException Add all the attributes, children and value from specified configuration element to current configuration element. Parameters other:Configuration the `Configuration` element deepCopy:boolean true will cause clones of the children to be added, false will add the original instances and is thus faster. throws ConfigurationException If there are any problems cloning the children.

public void addAll(final Configuration other, final boolean deepCopy) throws ConfigurationException

Add all the attributes, children and value from specified configuration element to current configuration element.

Parameters

other:Configuration: the Configuration element
deepCopy:boolean: true will cause clones of the children to be added, false will add the original instances and is thus faster. throws ConfigurationException If there are any problems cloning the children.

addAll back to summary

addAll	back to summary
public void addAll(final Configuration other) Implements org.apache.avalon.framework.configuration.MutableConfiguration.addAll. Add all the attributes, children and value from specified configuration element to current configuration element. Parameters other:Configuration the `Configuration` element

public void addAll(final Configuration other)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.addAll.

Add all the attributes, children and value from specified configuration element to current configuration element.

Parameters

other:Configuration: the Configuration element

addAllAttributes back to summary

addAllAttributes	back to summary
public void addAllAttributes(final Configuration other) Implements org.apache.avalon.framework.configuration.MutableConfiguration.addAllAttributes. Add all attributes from specified configuration element to current configuration element. Parameters other:Configuration the `Configuration` element

public void addAllAttributes(final Configuration other)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.addAllAttributes.

Add all attributes from specified configuration element to current configuration element.

Parameters

other:Configuration: the Configuration element

addAllChildren back to summary

addAllChildren	back to summary
public void addAllChildren(final Configuration other, final boolean deepCopy) throws ConfigurationException Add all child `Configuration` objects from specified configuration element to current configuration element. Parameters other:Configuration the other `Configuration` value throws ConfigurationException If there are any problems cloning the children. deepCopy:boolean true will cause clones of the children to be added, false will add the original instances and is thus faster.

public void addAllChildren(final Configuration other, final boolean deepCopy) throws ConfigurationException

Add all child Configuration objects from specified configuration element to current configuration element.

Parameters

other:Configuration: the other Configuration value throws ConfigurationException If there are any problems cloning the children.
deepCopy:boolean: true will cause clones of the children to be added, false will add the original instances and is thus faster.

addAllChildren back to summary

addAllChildren	back to summary
public void addAllChildren(final Configuration other) Implements org.apache.avalon.framework.configuration.MutableConfiguration.addAllChildren. Add all child `Configuration` objects from specified configuration element to current configuration element. Parameters other:Configuration the other `Configuration` value

public void addAllChildren(final Configuration other)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.addAllChildren.

Add all child Configuration objects from specified configuration element to current configuration element.

Parameters

other:Configuration: the other Configuration value

addAttribute back to summary

addAttribute	back to summary
public String addAttribute(final String name, String value) Deprecated Use setAttribute() instead Add an attribute to this configuration element, returning its old value or null. Parameters name:String a `String` value value:String a `String` value Returns:String a `String` value

public String addAttribute(final String name, String value)

Deprecated

Use setAttribute() instead

Add an attribute to this configuration element, returning its old value or null.

Parameters

name:String: a String value
value:String: a String value

Returns:String

a String value

addChild back to summary

addChild	back to summary
public void addChild(final Configuration configuration) Implements org.apache.avalon.framework.configuration.MutableConfiguration.addChild. Add a child `Configuration` to this configuration element. Parameters configuration:Configuration a `Configuration` value

public void addChild(final Configuration configuration)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.addChild.

Add a child Configuration to this configuration element.

Parameters

configuration:Configuration: a Configuration value

appendValueData back to summary

appendValueData	back to summary
public void appendValueData(final String value) Deprecated Use setValue() instead Append data to the value of this configuration element. Parameters value:String a `String` value

public void appendValueData(final String value)

Deprecated

Use setValue() instead

Append data to the value of this configuration element.

Parameters

value:String: a String value

check	back to summary
private boolean check(Object one, Object two)

checkWriteable	back to summary
protected final void checkWriteable() throws IllegalStateException heck if this configuration is writeable. Exceptions IllegalStateException: if this configuration s read-only

checkWriteable

back to summary

protected final void checkWriteable() throws IllegalStateException

heck if this configuration is writeable.

Exceptions

IllegalStateException:: if this configuration s read-only

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Compare if this configuration is equal to another. Parameters other:Object The other configuration Returns:boolean `true` if they are the same.

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Compare if this configuration is equal to another.

Parameters

other:Object: The other configuration

Returns:boolean

true if they are the same.

getAttribute back to summary

getAttribute	back to summary
public String getAttribute(final String name) throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getAttribute. Returns the value of the attribute specified by its name as a `String`. Parameters name:String a `String` value Returns:String a `String` value Exceptions ConfigurationException: If the attribute is not present.

public String getAttribute(final String name) throws ConfigurationException

Implements org.apache.avalon.framework.configuration.Configuration.getAttribute.

Returns the value of the attribute specified by its name as a String.

Parameters

name:String: a String value

Returns:String

a String value

Exceptions

ConfigurationException:: If the attribute is not present.

getAttributeNames back to summary

getAttributeNames	back to summary
public String[] getAttributeNames() Implements org.apache.avalon.framework.configuration.Configuration.getAttributeNames. Return an array of all attribute names. Returns:String[] a `String[]` value

public String[] getAttributeNames()

Implements org.apache.avalon.framework.configuration.Configuration.getAttributeNames.

Return an array of all attribute names.

Returns:String[]: a String[] value

getChild back to summary

getChild	back to summary
public Configuration getChild(final String name, final boolean createNew) Overrides org.apache.avalon.framework.configuration.AbstractConfiguration.getChild. Implements org.apache.avalon.framework.configuration.Configuration.getChild. Return the first `Configuration` object child of this associated with the given name. Parameters name:String a `String` value createNew:boolean a `boolean` value Returns:Configuration a `Configuration` value

public Configuration getChild(final String name, final boolean createNew)

Overrides org.apache.avalon.framework.configuration.AbstractConfiguration.getChild.

Implements org.apache.avalon.framework.configuration.Configuration.getChild.

Return the first Configuration object child of this associated with the given name.

Parameters

name:String: a String value
createNew:boolean: a boolean value

Returns:Configuration

a Configuration value

getChildCount back to summary

getChildCount	back to summary
public int getChildCount() Return count of children. Returns:int an `int` value

public int getChildCount()

Return count of children.

Returns:int: an int value

getChildren back to summary

getChildren	back to summary
public Configuration[] getChildren() Implements org.apache.avalon.framework.configuration.Configuration.getChildren. Return an array of `Configuration` elements containing all node children. Returns:Configuration[] The child nodes with name

public Configuration[] getChildren()

Implements org.apache.avalon.framework.configuration.Configuration.getChildren.

Return an array of Configuration elements containing all node children.

Returns:Configuration[]: The child nodes with name

getChildren back to summary

getChildren	back to summary
public Configuration[] getChildren(final String name) Implements org.apache.avalon.framework.configuration.Configuration.getChildren. Return an array of `Configuration` objects children of this associated with the given name. The returned array may be empty but is never `null`. Parameters name:String The name of the required children `Configuration`. Returns:Configuration[] a `Configuration[]` value

public Configuration[] getChildren(final String name)

Implements org.apache.avalon.framework.configuration.Configuration.getChildren.

Return an array of Configuration objects children of this associated with the given name.
The returned array may be empty but is never null.

Parameters

name:String: The name of the required children Configuration.

Returns:Configuration[]

a Configuration[] value

getLocation back to summary

getLocation	back to summary
public String getLocation() Implements org.apache.avalon.framework.configuration.Configuration.getLocation. Returns a description of location of element. Returns:String a `String` value

public String getLocation()

Implements org.apache.avalon.framework.configuration.Configuration.getLocation.

Returns a description of location of element.

Returns:String: a String value

getMutableChild back to summary

getMutableChild	back to summary
public MutableConfiguration getMutableChild(final String name) throws ConfigurationException Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChild. Doc from org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChild. Equivalent to `getMutableChild( name, true )`

public MutableConfiguration getMutableChild(final String name) throws ConfigurationException

Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChild.

Doc from org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChild.

Equivalent to getMutableChild( name, true )

getMutableChild back to summary

getMutableChild	back to summary
public MutableConfiguration getMutableChild(final String name, boolean autoCreate) throws ConfigurationException Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChild. Doc from org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChild. Gets a child node of this configuration. If a mutable child with the given name exists, it is returned. If an immutable child with the given name exists, it is converted into a mutable child and returned. In this case, the immutable child will be replaced with the mutable child in this configuration (that is, it will be as if the child node always had been mutable). If no child with the given name exists, and `autoCreate` is `true`, a new mutable child is created and added to this configuration before being returned. Parameters name:String the name of the child. autoCreate:boolean set to true to create the child node if it doesn't exist. Returns:MutableConfiguration the child MutableConfiguration, or `null` if `autoCreate` was false and no child by the given name existed. Exceptions ConfigurationException: if an error occurrs.

public MutableConfiguration getMutableChild(final String name, boolean autoCreate) throws ConfigurationException

Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChild.

Doc from org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChild.

Gets a child node of this configuration. If a mutable child with the given name exists, it is returned. If an immutable child with the given name exists, it is converted into a mutable child and returned. In this case, the immutable child will be replaced with the mutable child in this configuration (that is, it will be as if the child node always had been mutable). If no child with the given name exists, and autoCreate is true, a new mutable child is created and added to this configuration before being returned.

Parameters

name:String: the name of the child.
autoCreate:boolean: set to true to create the child node if it doesn't exist.

Returns:MutableConfiguration

the child MutableConfiguration, or null if autoCreate was false and no child by the given name existed.

Exceptions

ConfigurationException:: if an error occurrs.

getMutableChildren back to summary

getMutableChildren	back to summary
public MutableConfiguration[] getMutableChildren() throws ConfigurationException Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChildren. Doc from org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChildren. Returns an array of mutable children. Immutable children are converted just as for `getMutableChild`. Exceptions ConfigurationException: if an error occurrs.

public MutableConfiguration[] getMutableChildren() throws ConfigurationException

Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChildren.

Doc from org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChildren.

Returns an array of mutable children. Immutable children are converted just as for getMutableChild.

Exceptions

ConfigurationException:: if an error occurrs.

getMutableChildren back to summary

getMutableChildren	back to summary
public MutableConfiguration[] getMutableChildren(final String name) throws ConfigurationException Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChildren. Doc from org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChildren. Returns an array of mutable children with the given name. Immutable children are converted just as for `getMutableChild`. Exceptions ConfigurationException: if an error occurrs.

public MutableConfiguration[] getMutableChildren(final String name) throws ConfigurationException

Implements org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChildren.

Doc from org.apache.avalon.framework.configuration.MutableConfiguration.getMutableChildren.

Returns an array of mutable children with the given name. Immutable children are converted just as for getMutableChild.

Exceptions

ConfigurationException:: if an error occurrs.

getName back to summary

getName	back to summary
public String getName() Implements org.apache.avalon.framework.configuration.Configuration.getName. Returns the name of this configuration element. Returns:String a `String` value

public String getName()

Implements org.apache.avalon.framework.configuration.Configuration.getName.

Returns the name of this configuration element.

Returns:String: a String value

getNamespace back to summary

getNamespace	back to summary
public String getNamespace() throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getNamespace. Returns the namespace of this configuration element Returns:String a `String` value Exceptions ConfigurationException: if an error occurs Since 4.1

public String getNamespace() throws ConfigurationException

Implements org.apache.avalon.framework.configuration.Configuration.getNamespace.

Returns the namespace of this configuration element

Returns:String

a String value

Exceptions

ConfigurationException:: if an error occurs

Since

4.1

getPrefix back to summary

getPrefix	back to summary
protected String getPrefix() throws ConfigurationException Implements abstract org.apache.avalon.framework.configuration.AbstractConfiguration.getPrefix. Returns the prefix of the namespace Returns:String a `String` value Exceptions ConfigurationException: if prefix is not present (`null`). Since 4.1

protected String getPrefix() throws ConfigurationException

Implements abstract org.apache.avalon.framework.configuration.AbstractConfiguration.getPrefix.

Returns the prefix of the namespace

Returns:String

a String value

Exceptions

ConfigurationException:: if prefix is not present (null).

Since

4.1

getValue back to summary

getValue	back to summary
public String getValue(final String defaultValue) Overrides org.apache.avalon.framework.configuration.AbstractConfiguration.getValue. Implements org.apache.avalon.framework.configuration.Configuration.getValue. Returns the value of the configuration element as a `String`. Parameters defaultValue:String the default value to return if value malformed or empty Returns:String a `String` value

public String getValue(final String defaultValue)

Overrides org.apache.avalon.framework.configuration.AbstractConfiguration.getValue.

Implements org.apache.avalon.framework.configuration.Configuration.getValue.

Returns the value of the configuration element as a String.

Parameters

defaultValue:String: the default value to return if value malformed or empty

Returns:String

a String value

getValue back to summary

getValue	back to summary
public String getValue() throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getValue. Returns the value of the configuration element as a `String`. Returns:String a `String` value Exceptions ConfigurationException: If the value is not present.

public String getValue() throws ConfigurationException

Implements org.apache.avalon.framework.configuration.Configuration.getValue.

Returns the value of the configuration element as a String.

Returns:String

a String value

Exceptions

ConfigurationException:: If the value is not present.

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Obtaine the hashcode for this configuration. Returns:int the hashcode.

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Obtaine the hashcode for this configuration.

Returns:int: the hashcode.

isReadOnly	back to summary
protected final boolean isReadOnly() Returns true iff this DefaultConfiguration has been made read-only.

makeReadOnly	back to summary
public void makeReadOnly() Make this configuration read-only.

removeChild back to summary

removeChild	back to summary
public void removeChild(final Configuration configuration) Implements org.apache.avalon.framework.configuration.MutableConfiguration.removeChild. Remove a child `Configuration` to this configuration element. Parameters configuration:Configuration a `Configuration` value

public void removeChild(final Configuration configuration)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.removeChild.

Remove a child Configuration to this configuration element.

Parameters

configuration:Configuration: a Configuration value

setAttribute back to summary

setAttribute	back to summary
public void setAttribute(final String name, final String value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute. Set the value of the specified attribute to the specified string. Parameters name:String name of the attribute to set value:String a `String` value

public void setAttribute(final String name, final String value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute.

Set the value of the specified attribute to the specified string.

Parameters

name:String: name of the attribute to set
value:String: a String value

setAttribute back to summary

setAttribute	back to summary
public void setAttribute(final String name, final int value) Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute. Set the value of the specified attribute to the specified int. Parameters name:String name of the attribute to set value:int an `int` value

public void setAttribute(final String name, final int value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute.

Set the value of the specified attribute to the specified int.

Parameters

name:String: name of the attribute to set
value:int: an int value

setAttribute back to summary

public void setAttribute(final String name, final long value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute.

Set the value of the specified attribute to the specified long.

Parameters

name:String: name of the attribute to set
value:long: an long value

setAttribute back to summary

public void setAttribute(final String name, final boolean value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute.

Set the value of the specified attribute to the specified boolean.

Parameters

name:String: name of the attribute to set
value:boolean: an boolean value

setAttribute back to summary

public void setAttribute(final String name, final float value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute.

Set the value of the specified attribute to the specified float.

Parameters

name:String: name of the attribute to set
value:float: an float value

setAttribute back to summary

public void setAttribute(final String name, final double value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setAttribute.

Set the value of the specified attribute to the specified double.

Parameters

name:String: name of the attribute to set
value:double: an double value

setValue back to summary

public void setValue(final String value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue.

Set the value of this Configuration object to the specified string.

Parameters

value:String: a String value

setValue back to summary

public void setValue(final int value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue.

Set the value of this Configuration object to the specified int.

Parameters

value:int: a int value

setValue back to summary

public void setValue(final long value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue.

Set the value of this Configuration object to the specified long.

Parameters

value:long: a long value

setValue back to summary

public void setValue(final boolean value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue.

Set the value of this Configuration object to the specified boolean.

Parameters

value:boolean: a boolean value

setValue back to summary

public void setValue(final float value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue.

Set the value of this Configuration object to the specified float.

Parameters

value:float: a float value

setValue back to summary

public void setValue(final double value)

Implements org.apache.avalon.framework.configuration.MutableConfiguration.setValue.

Set the value of this Configuration object to the specified double.

Parameters

value:double: a double value

toMutable

back to summary

private MutableConfiguration toMutable(Configuration child) throws ConfigurationException

Convenience function to convert a child to a mutable configuration. If the child is-a MutableConfiguration, and it isn't a read-only DefaultConfiguration (which isn't really mutable), the child is cast to MutableConfiguration and returned. If not, the child is replaced in the m_children array with a new writable DefaultConfiguration that is a shallow copy of the child, and the new child is returned.

public Class DefaultConfiguration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail