org.apache.avalon.framework.configuration
Class DefaultConfiguration

java.lang.Object
  |
  +--org.apache.avalon.framework.configuration.AbstractConfiguration
        |
        +--org.apache.avalon.framework.configuration.DefaultConfiguration
All Implemented Interfaces:
Configuration, java.io.Serializable

public class DefaultConfiguration
extends AbstractConfiguration
implements java.io.Serializable

This is the default Configuration implementation.

Author:
Federico Barbieri, Stefano Mazzocchi, Pierpaolo Fumagalli, Peter Donald
See Also:
Serialized Form

Field Summary
protected static Configuration[] EMPTY_ARRAY
           
 
Constructor Summary
DefaultConfiguration(java.lang.String name, java.lang.String location)
          Create a new DefaultConfiguration instance.
DefaultConfiguration(java.lang.String name, java.lang.String location, java.lang.String ns, java.lang.String prefix)
          Create a new DefaultConfiguration instance.
 
Method Summary
 java.lang.String addAttribute(java.lang.String name, java.lang.String value)
          Deprecated. Use setAttribute() instead
 void addChild(Configuration configuration)
          Add a child Configuration to this configuration element.
 void appendValueData(java.lang.String value)
          Deprecated. Use setValue() instead
protected  void checkWriteable()
           
 java.lang.String getAttribute(java.lang.String name)
          Returns the value of the attribute specified by its name as a String.
 java.lang.String[] getAttributeNames()
          Return an array of all attribute names.
 Configuration getChild(java.lang.String name, boolean createNew)
          Return the first Configuration object child of this associated with the given name.
 int getChildCount()
          Return count of children.
 Configuration[] getChildren()
          Return an Iterator of Configuration elements containing all node children.
 Configuration[] getChildren(java.lang.String name)
          Return an Enumeration of Configuration objects children of this associated with the given name.
 java.lang.String getLocation()
          Returns a description of location of element.
 java.lang.String getName()
          Returns the name of this configuration element.
 java.lang.String getNamespace()
          Returns the namespace of this configuration element
protected  java.lang.String getPrefix()
          Returns the prefix of the namespace
 java.lang.String getValue()
          Returns the value of the configuration element as a String.
 void makeReadOnly()
           
 void removeChild(Configuration configuration)
          Remove a child Configuration to this configuration element.
 void setAttribute(java.lang.String name, java.lang.String value)
           
 void setValue(java.lang.String value)
           
 
Methods inherited from class org.apache.avalon.framework.configuration.AbstractConfiguration
getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsFloat, getAttributeAsFloat, getAttributeAsInteger, getAttributeAsInteger, getAttributeAsLong, getAttributeAsLong, getChild, getValue, getValueAsBoolean, getValueAsBoolean, getValueAsFloat, getValueAsFloat, getValueAsInteger, getValueAsInteger, getValueAsLong, getValueAsLong
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY_ARRAY

protected static final Configuration[] EMPTY_ARRAY
Constructor Detail

DefaultConfiguration

public DefaultConfiguration(java.lang.String name,
                            java.lang.String location)
Create a new DefaultConfiguration instance.

DefaultConfiguration

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

getName

public java.lang.String getName()
Returns the name of this configuration element.
Following copied from interface: org.apache.avalon.framework.configuration.Configuration
Returns:
name of the Configuration node.

getNamespace

public java.lang.String getNamespace()
                              throws ConfigurationException
Returns the namespace of this configuration element
Following copied from interface: org.apache.avalon.framework.configuration.Configuration
Returns:
a String identifying the namespace of this Configuration.

getPrefix

protected java.lang.String getPrefix()
                              throws ConfigurationException
Returns the prefix of the namespace
Overrides:
getPrefix in class AbstractConfiguration
Throws:
ConfigurationException - if prefix is not present (null).

getLocation

public java.lang.String getLocation()
Returns a description of location of element.
Following copied from interface: org.apache.avalon.framework.configuration.Configuration
Returns:
a string describing location of Configuration

getValue

public java.lang.String getValue()
                          throws ConfigurationException
Returns the value of the configuration element as a String.
Throws:
ConfigurationException - If the value is not present.

getAttributeNames

public java.lang.String[] getAttributeNames()
Return an array of all attribute names.

getChildren

public Configuration[] getChildren()
Return an Iterator of Configuration elements containing all node children.
Returns:
The child nodes with name

getAttribute

public java.lang.String getAttribute(java.lang.String name)
                              throws ConfigurationException
Returns the value of the attribute specified by its name as a String.
Throws:
ConfigurationException - If the attribute is not present.

getChild

public Configuration getChild(java.lang.String name,
                              boolean createNew)
Return the first Configuration object child of this associated with the given name.
Overrides:
getChild in class AbstractConfiguration
Following copied from class: org.apache.avalon.framework.configuration.AbstractConfiguration
Parameters:
name - the name of the child
createNew - true if you want to create a new Configuration object if none exists
Returns:
the child Configuration

getChildren

public Configuration[] getChildren(java.lang.String name)
Return an Enumeration of Configuration objects children of this associated with the given name.
The returned Enumeration may be empty.
Parameters:
name - The name of the required children Configuration.

appendValueData

public void appendValueData(java.lang.String value)
Deprecated. Use setValue() instead

Append data to the value of this configuration element.

setValue

public void setValue(java.lang.String value)

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)

addAttribute

public java.lang.String addAttribute(java.lang.String name,
                                     java.lang.String value)
Deprecated. Use setAttribute() instead

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

addChild

public void addChild(Configuration configuration)
Add a child Configuration to this configuration element.

removeChild

public void removeChild(Configuration configuration)
Remove a child Configuration to this configuration element.

getChildCount

public int getChildCount()
Return count of children.

makeReadOnly

public void makeReadOnly()

checkWriteable

protected final void checkWriteable()
                             throws java.lang.IllegalStateException


"Copyright © 2001 Apache Jakarta Project. All Rights Reserved."