Class AbstractConfiguration
java.lang.Object
org.apache.avalon.framework.configuration.AbstractConfiguration
- All Implemented Interfaces:
org.apache.avalon.framework.configuration.Configuration
- Direct Known Subclasses:
DefaultConfiguration
,DefaultImmutableConfiguration
public abstract class AbstractConfiguration
extends Object
implements org.apache.avalon.framework.configuration.Configuration
This is an abstract
Configuration
implementation that deals
with methods that can be abstracted away from underlying implementations.- Version:
- $Id: AbstractConfiguration.java 156533 2005-03-08 08:51:40 -0600 (Tue, 08 Mar 2005) leif $
- Author:
- Avalon Development Team
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetAttribute
(String name, String defaultValue) Returns the value of the attribute specified by its name as aString
.boolean
getAttributeAsBoolean
(String name) Returns the value of the attribute specified by its name as aboolean
.boolean
getAttributeAsBoolean
(String name, boolean defaultValue) Returns the value of the attribute specified by its name as aboolean
.double
getAttributeAsDouble
(String name) Returns the value of the attribute specified by its name as adouble
.double
getAttributeAsDouble
(String name, double defaultValue) Returns the value of the attribute specified by its name as adouble
.float
getAttributeAsFloat
(String name) Returns the value of the attribute specified by its name as afloat
.float
getAttributeAsFloat
(String name, float defaultValue) Returns the value of the attribute specified by its name as afloat
.int
getAttributeAsInteger
(String name) Returns the value of the attribute specified by its name as anint
.int
getAttributeAsInteger
(String name, int defaultValue) Returns the value of the attribute specified by its name as anint
.long
getAttributeAsLong
(String name) Returns the value of the attribute specified by its name as along
.long
getAttributeAsLong
(String name, long defaultValue) Returns the value of the attribute specified by its name as along
.org.apache.avalon.framework.configuration.Configuration
Return the firstConfiguration
object child of this associated with the given name.org.apache.avalon.framework.configuration.Configuration
Return the firstConfiguration
object child of this associated with the given name.protected abstract String
Returns the prefix of the namespace.Returns the value of the configuration element as aString
.boolean
Returns the value of the configuration element as aboolean
.boolean
getValueAsBoolean
(boolean defaultValue) Returns the value of the configuration element as aboolean
.double
Returns the value of the configuration element as adouble
.double
getValueAsDouble
(double defaultValue) Returns the value of the configuration element as adouble
.float
Returns the value of the configuration element as afloat
.float
getValueAsFloat
(float defaultValue) Returns the value of the configuration element as afloat
.int
Returns the value of the configuration element as anint
.int
getValueAsInteger
(int defaultValue) Returns the value of the configuration element as anint
.long
Returns the value of the configuration element as along
.long
getValueAsLong
(long defaultValue) Returns the value of the configuration element as along
.private boolean
private boolean
toString()
The toString() operation is used for debugging information.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.avalon.framework.configuration.Configuration
getAttribute, getAttributeNames, getChildren, getChildren, getLocation, getName, getNamespace, getValue
-
Constructor Details
-
AbstractConfiguration
public AbstractConfiguration()
-
-
Method Details
-
getPrefix
protected abstract String getPrefix() throws org.apache.avalon.framework.configuration.ConfigurationExceptionReturns the prefix of the namespace. This is only used as a serialization hint, therefore is not part of the client API. It should be included in all Configuration implementations though.- Returns:
- A non-null String (defaults to "")
- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
- if no prefix was defined (prefix isnull
.- Since:
- 4.1
-
getValueAsInteger
public int getValueAsInteger() throws org.apache.avalon.framework.configuration.ConfigurationExceptionReturns the value of the configuration element as anint
. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.- Specified by:
getValueAsInteger
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Returns:
- the value
- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
getValueAsInteger
public int getValueAsInteger(int defaultValue) Returns the value of the configuration element as anint
. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.- Specified by:
getValueAsInteger
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
defaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getValueAsLong
public long getValueAsLong() throws org.apache.avalon.framework.configuration.ConfigurationExceptionReturns the value of the configuration element as along
. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.- Specified by:
getValueAsLong
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Returns:
- the value
- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
getValueAsLong
public long getValueAsLong(long defaultValue) Returns the value of the configuration element as along
. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.- Specified by:
getValueAsLong
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
defaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getValueAsFloat
public float getValueAsFloat() throws org.apache.avalon.framework.configuration.ConfigurationExceptionReturns the value of the configuration element as afloat
.- Specified by:
getValueAsFloat
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Returns:
- the value
- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
getValueAsFloat
public float getValueAsFloat(float defaultValue) Returns the value of the configuration element as afloat
.- Specified by:
getValueAsFloat
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
defaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getValueAsDouble
public double getValueAsDouble() throws org.apache.avalon.framework.configuration.ConfigurationExceptionReturns the value of the configuration element as adouble
.- Specified by:
getValueAsDouble
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Returns:
- the value
- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
getValueAsDouble
public double getValueAsDouble(double defaultValue) Returns the value of the configuration element as adouble
.- Specified by:
getValueAsDouble
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
defaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getValueAsBoolean
public boolean getValueAsBoolean() throws org.apache.avalon.framework.configuration.ConfigurationExceptionReturns the value of the configuration element as aboolean
.- Specified by:
getValueAsBoolean
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Returns:
- the value
- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
getValueAsBoolean
public boolean getValueAsBoolean(boolean defaultValue) Returns the value of the configuration element as aboolean
.- Specified by:
getValueAsBoolean
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
defaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getValue
Returns the value of the configuration element as aString
.- Specified by:
getValue
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
defaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getAttributeAsInteger
public int getAttributeAsInteger(String name) throws org.apache.avalon.framework.configuration.ConfigurationException Returns the value of the attribute specified by its name as anint
. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.- Specified by:
getAttributeAsInteger
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the attribute- Returns:
- the value
- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
getAttributeAsInteger
Returns the value of the attribute specified by its name as anint
. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.- Specified by:
getAttributeAsInteger
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the attributedefaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getAttributeAsLong
public long getAttributeAsLong(String name) throws org.apache.avalon.framework.configuration.ConfigurationException Returns the value of the attribute specified by its name as along
. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.- Specified by:
getAttributeAsLong
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the attribute- Returns:
- the value
- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
getAttributeAsLong
Returns the value of the attribute specified by its name as along
. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.- Specified by:
getAttributeAsLong
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the attributedefaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getAttributeAsFloat
public float getAttributeAsFloat(String name) throws org.apache.avalon.framework.configuration.ConfigurationException Returns the value of the attribute specified by its name as afloat
.- Specified by:
getAttributeAsFloat
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the attribute- Returns:
- the value
- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
getAttributeAsFloat
Returns the value of the attribute specified by its name as afloat
.- Specified by:
getAttributeAsFloat
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the attributedefaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getAttributeAsDouble
public double getAttributeAsDouble(String name) throws org.apache.avalon.framework.configuration.ConfigurationException Returns the value of the attribute specified by its name as adouble
.- Specified by:
getAttributeAsDouble
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the attribute- Returns:
- the value
- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
getAttributeAsDouble
Returns the value of the attribute specified by its name as adouble
.- Specified by:
getAttributeAsDouble
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the attributedefaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getAttributeAsBoolean
public boolean getAttributeAsBoolean(String name) throws org.apache.avalon.framework.configuration.ConfigurationException Returns the value of the attribute specified by its name as aboolean
.- Specified by:
getAttributeAsBoolean
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the attribute- Returns:
- the value
- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
isTrue
-
isFalse
-
getAttributeAsBoolean
Returns the value of the attribute specified by its name as aboolean
.- Specified by:
getAttributeAsBoolean
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the attributedefaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getAttribute
Returns the value of the attribute specified by its name as aString
.- Specified by:
getAttribute
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the attributedefaultValue
- the default value to return if value malformed or empty- Returns:
- the value
-
getChild
Return the firstConfiguration
object child of this associated with the given name. If no such child exists, a new one will be created.- Specified by:
getChild
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the child- Returns:
- the child Configuration
-
getChild
public org.apache.avalon.framework.configuration.Configuration getChild(String name, boolean createNew) Return the firstConfiguration
object child of this associated with the given name.- Specified by:
getChild
in interfaceorg.apache.avalon.framework.configuration.Configuration
- Parameters:
name
- the name of the childcreateNew
- true if you want to create a new Configuration object if none exists- Returns:
- the child Configuration
-
toString
The toString() operation is used for debugging information. It does not create a deep reproduction of this configuration and all child configurations, instead it displays the name, value, and location.
-