org.apache.avalon.framework.configuration

Interface MutableConfiguration

All Superinterfaces:
Configuration

public interface MutableConfiguration
extends Configuration

A read/write extension of the Configuration interface.
Version:
CVS $Revision: 1.2 $ $Date: 2004/03/28 02:55:36 $
Author:
Avalon Development Team
Since:
4.1.6

Method Summary

void
addAll(Configuration other)
Add all the attributes, children and value from specified configuration element to current configuration element.
void
addAllAttributes(Configuration other)
Add all attributes from specified configuration element to current configuration element.
void
addAllChildren(Configuration other)
Add all child Configuration objects from specified configuration element to current configuration element.
void
addChild(Configuration configuration)
Add a child Configuration to this configuration element.
MutableConfiguration
getMutableChild(String name)
Equivalent to getMutableChild( name, true )
MutableConfiguration
getMutableChild(String name, boolean autoCreate)
Gets a child node of this configuration.
MutableConfiguration[]
getMutableChildren()
Returns an array of mutable children.
MutableConfiguration[]
getMutableChildren(String name)
Returns an array of mutable children with the given name.
void
removeChild(Configuration configuration)
Remove a child Configuration to this configuration element.
void
setAttribute(String name, String value)
Set the value of the specified attribute to the specified string.
void
setAttribute(String name, boolean value)
Set the value of the specified attribute to the specified boolean.
void
setAttribute(String name, float value)
Set the value of the specified attribute to the specified float.
void
setAttribute(String name, int value)
Set the value of the specified attribute to the specified int.
void
setAttribute(String name, long value)
Set the value of the specified attribute to the specified long.
void
setValue(String value)
Set the value of this Configuration object to the specified string.
void
setValue(boolean value)
Set the value of this Configuration object to the specified boolean.
void
setValue(float value)
Set the value of this Configuration object to the specified float.
void
setValue(int value)
Set the value of this Configuration object to the specified int.
void
setValue(long value)
Set the value of this Configuration object to the specified long.

Method Details

addAll

public void addAll(Configuration other)
Add all the attributes, children and value from specified configuration element to current configuration element.
Parameters:
other - the Configuration element

addAllAttributes

public void addAllAttributes(Configuration other)
Add all attributes from specified configuration element to current configuration element.
Parameters:
other - the Configuration element

addAllChildren

public void addAllChildren(Configuration other)
Add all child Configuration objects from specified configuration element to current configuration element.
Parameters:
other - the other Configuration value

addChild

public void addChild(Configuration configuration)
Add a child Configuration to this configuration element.
Parameters:
configuration - a Configuration value

getMutableChild

public MutableConfiguration getMutableChild(String name)
            throws ConfigurationException
Equivalent to getMutableChild( name, true )

getMutableChild

public MutableConfiguration getMutableChild(String name,
                                            boolean autoCreate)
            throws ConfigurationException
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 - the name of the child.
autoCreate - set to true to create the child node if it doesn't exist.
Returns:
the child MutableConfiguration, or null if autoCreate was false and no child by the given name existed.

getMutableChildren

public MutableConfiguration[] getMutableChildren()
            throws ConfigurationException
Returns an array of mutable children. Immutable children are converted just as for getMutableChild.

getMutableChildren

public MutableConfiguration[] getMutableChildren(String name)
            throws ConfigurationException
Returns an array of mutable children with the given name. Immutable children are converted just as for getMutableChild.

removeChild

public void removeChild(Configuration configuration)
Remove a child Configuration to this configuration element.
Parameters:
configuration - a Configuration value

setAttribute

public void setAttribute(String name,
                         String value)
Set the value of the specified attribute to the specified string.
Parameters:
name - name of the attribute to set
value - a String value. If null, the attribute is removed.

setAttribute

public void setAttribute(String name,
                         boolean value)
Set the value of the specified attribute to the specified boolean.
Parameters:
name - name of the attribute to set
value - an boolean value

setAttribute

public void setAttribute(String name,
                         float value)
Set the value of the specified attribute to the specified float.
Parameters:
name - name of the attribute to set
value - an float value

setAttribute

public void setAttribute(String name,
                         int value)
Set the value of the specified attribute to the specified int.
Parameters:
name - name of the attribute to set
value - an int value

setAttribute

public void setAttribute(String name,
                         long value)
Set the value of the specified attribute to the specified long.
Parameters:
name - name of the attribute to set
value - an long value

setValue

public void setValue(String value)
Set the value of this Configuration object to the specified string.
Parameters:
value - a String value

setValue

public void setValue(boolean value)
Set the value of this Configuration object to the specified boolean.
Parameters:
value - a boolean value

setValue

public void setValue(float value)
Set the value of this Configuration object to the specified float.
Parameters:
value - a float value

setValue

public void setValue(int value)
Set the value of this Configuration object to the specified int.
Parameters:
value - a int value

setValue

public void setValue(long value)
Set the value of this Configuration object to the specified long.
Parameters:
value - a long value