Class DefaultImmutableConfiguration
- java.lang.Object
-
- org.apache.avalon.framework.configuration.AbstractConfiguration
-
- org.apache.avalon.framework.configuration.DefaultImmutableConfiguration
-
- All Implemented Interfaces:
java.io.Serializable
,Configuration
public class DefaultImmutableConfiguration extends AbstractConfiguration implements java.io.Serializable
An immutable implementation of theConfiguration
interface.- Version:
- $Id: DefaultImmutableConfiguration.java 30977 2004-07-30 03:57:54 -0500 (Fri, 30 Jul 2004) niclas $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected static Configuration[]
EMPTY_ARRAY
An empty (length zero) array of configuration objects.private java.util.HashMap
m_attributes
private java.util.ArrayList
m_children
private java.lang.String
m_location
private java.lang.String
m_name
private java.lang.String
m_namespace
private java.lang.String
m_prefix
private java.lang.String
m_value
-
Constructor Summary
Constructors Constructor Description DefaultImmutableConfiguration(Configuration config)
Deep copy constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object other)
Compare if this configuration is equal to another.java.lang.String
getAttribute(java.lang.String name)
Returns the value of the attribute specified by its name as aString
.java.lang.String[]
getAttributeNames()
Return an array of all attribute names.Configuration
getChild(java.lang.String name, boolean createNew)
Return the firstConfiguration
object child of this associated with the given name.int
getChildCount()
Return count of children.Configuration[]
getChildren()
Return an array ofConfiguration
elements containing all node children.Configuration[]
getChildren(java.lang.String name)
Return an array ofConfiguration
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 elementprotected java.lang.String
getPrefix()
Returns the prefix of the namespacejava.lang.String
getValue()
Returns the value of the configuration element as aString
.java.lang.String
getValue(java.lang.String defaultValue)
Returns the value of the configuration element as aString
.int
hashCode()
Obtaine the hashcode for this configuration.-
Methods inherited from class org.apache.avalon.framework.configuration.AbstractConfiguration
getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsFloat, getAttributeAsInteger, getAttributeAsInteger, getAttributeAsLong, getAttributeAsLong, getChild, getValueAsBoolean, getValueAsBoolean, getValueAsDouble, getValueAsDouble, getValueAsFloat, getValueAsFloat, getValueAsInteger, getValueAsInteger, getValueAsLong, getValueAsLong, toString
-
-
-
-
Field Detail
-
EMPTY_ARRAY
protected static final Configuration[] EMPTY_ARRAY
An empty (length zero) array of configuration objects.
-
m_name
private final java.lang.String m_name
-
m_location
private final java.lang.String m_location
-
m_namespace
private final java.lang.String m_namespace
-
m_prefix
private final java.lang.String m_prefix
-
m_attributes
private final java.util.HashMap m_attributes
-
m_children
private final java.util.ArrayList m_children
-
m_value
private final java.lang.String m_value
-
-
Constructor Detail
-
DefaultImmutableConfiguration
public DefaultImmutableConfiguration(Configuration config) throws ConfigurationException
Deep copy constructor.- Parameters:
config
- theConfiguration
to do a deep copy of.- Throws:
ConfigurationException
- if an error occurs when copying
-
-
Method Detail
-
getName
public java.lang.String getName()
Returns the name of this configuration element.- Specified by:
getName
in interfaceConfiguration
- Returns:
- a
String
value
-
getNamespace
public java.lang.String getNamespace() throws ConfigurationException
Returns the namespace of this configuration element- Specified by:
getNamespace
in interfaceConfiguration
- Returns:
- a
String
value - Throws:
ConfigurationException
- if an error occurs- Since:
- 4.1
-
getPrefix
protected java.lang.String getPrefix() throws ConfigurationException
Returns the prefix of the namespace- Specified by:
getPrefix
in classAbstractConfiguration
- Returns:
- a
String
value - Throws:
ConfigurationException
- if prefix is not present (null
).- Since:
- 4.1
-
getLocation
public java.lang.String getLocation()
Returns a description of location of element.- Specified by:
getLocation
in interfaceConfiguration
- Returns:
- a
String
value
-
getValue
public java.lang.String getValue(java.lang.String defaultValue)
Returns the value of the configuration element as aString
.- Specified by:
getValue
in interfaceConfiguration
- Overrides:
getValue
in classAbstractConfiguration
- Parameters:
defaultValue
- the default value to return if value malformed or empty- Returns:
- a
String
value
-
getValue
public java.lang.String getValue() throws ConfigurationException
Returns the value of the configuration element as aString
.- Specified by:
getValue
in interfaceConfiguration
- Returns:
- a
String
value - Throws:
ConfigurationException
- If the value is not present.
-
getAttributeNames
public java.lang.String[] getAttributeNames()
Return an array of all attribute names.- Specified by:
getAttributeNames
in interfaceConfiguration
- Returns:
- a
String[]
value
-
getChildren
public Configuration[] getChildren()
Return an array ofConfiguration
elements containing all node children.- Specified by:
getChildren
in interfaceConfiguration
- 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 aString
.- Specified by:
getAttribute
in interfaceConfiguration
- Parameters:
name
- aString
value- Returns:
- a
String
value - Throws:
ConfigurationException
- If the attribute is not present.
-
getChild
public Configuration getChild(java.lang.String name, boolean createNew)
Return the firstConfiguration
object child of this associated with the given name.- Specified by:
getChild
in interfaceConfiguration
- Overrides:
getChild
in classAbstractConfiguration
- Parameters:
name
- aString
valuecreateNew
- aboolean
value- Returns:
- a
Configuration
value
-
getChildren
public Configuration[] getChildren(java.lang.String name)
Return an array ofConfiguration
objects children of this associated with the given name.
The returned array may be empty but is nevernull
.- Specified by:
getChildren
in interfaceConfiguration
- Parameters:
name
- The name of the required childrenConfiguration
.- Returns:
- a
Configuration[]
value
-
getChildCount
public int getChildCount()
Return count of children.- Returns:
- an
int
value
-
equals
public boolean equals(java.lang.Object other)
Compare if this configuration is equal to another.- Overrides:
equals
in classjava.lang.Object
- Parameters:
other
- The other configuration- Returns:
true
if they are the same.
-
hashCode
public int hashCode()
Obtaine the hashcode for this configuration.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- the hashcode.
-
-