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

Access	Constructor and Description
public	AbstractConfiguration()

Method Summary

Modifier and Type	Method and Description
public String	Returns: the value getAttribute(final String the name of the attribute name, final String the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttribute. Returns the value of the attribute specified by its name as a `String`.
public boolean	Returns: the value getAttributeAsBoolean(final String the name of the attribute name) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsBoolean. Returns the value of the attribute specified by its name as a `boolean`.
public boolean	Returns: the value getAttributeAsBoolean(final String the name of the attribute name, final boolean the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsBoolean. Returns the value of the attribute specified by its name as a `boolean`.
public double	Returns: the value getAttributeAsDouble(final String the name of the attribute name) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsDouble. Returns the value of the attribute specified by its name as a `double`.
public double	Returns: the value getAttributeAsDouble(final String the name of the attribute name, final double the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsDouble. Returns the value of the attribute specified by its name as a `double`.
public float	Returns: the value getAttributeAsFloat(final String the name of the attribute name) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsFloat. Returns the value of the attribute specified by its name as a `float`.
public float	Returns: the value getAttributeAsFloat(final String the name of the attribute name, final float the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsFloat. Returns the value of the attribute specified by its name as a `float`.
public int	Returns: the value getAttributeAsInteger(final String the name of the attribute name) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsInteger. Returns the value of the attribute specified by its name as an `int`.
public int	Returns: the value getAttributeAsInteger(final String the name of the attribute name, final int the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsInteger. Returns the value of the attribute specified by its name as an `int`.
public long	Returns: the value getAttributeAsLong(final String the name of the attribute name) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsLong. Returns the value of the attribute specified by its name as a `long`.
public long	Returns: the value getAttributeAsLong(final String the name of the attribute name, final long the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsLong. Returns the value of the attribute specified by its name as a `long`.
public Configuration	Returns: the child Configuration getChild(final String the name of the child name) Implements org.apache.avalon.framework.configuration.Configuration.getChild. Return the first `Configuration` object child of this associated with the given name.
public Configuration	Returns: the child Configuration getChild(final String the name of the child name, final boolean true if you want to create a new Configuration object if none exists createNew) Implements org.apache.avalon.framework.configuration.Configuration.getChild. Return the first `Configuration` object child of this associated with the given name.
protected abstract String	Returns: A non-null String (defaults to "") getPrefix() Returns the prefix of the namespace.
public String	Returns: the value getValue(final String the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getValue. Returns the value of the configuration element as a `String`.
public boolean	Returns: the value getValueAsBoolean() Implements org.apache.avalon.framework.configuration.Configuration.getValueAsBoolean. Returns the value of the configuration element as a `boolean`.
public boolean	Returns: the value getValueAsBoolean(final boolean the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getValueAsBoolean. Returns the value of the configuration element as a `boolean`.
public double	Returns: the value getValueAsDouble() Implements org.apache.avalon.framework.configuration.Configuration.getValueAsDouble. Returns the value of the configuration element as a `double`.
public double	Returns: the value getValueAsDouble(final double the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getValueAsDouble. Returns the value of the configuration element as a `double`.
public float	Returns: the value getValueAsFloat() Implements org.apache.avalon.framework.configuration.Configuration.getValueAsFloat. Returns the value of the configuration element as a `float`.
public float	Returns: the value getValueAsFloat(final float the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getValueAsFloat. Returns the value of the configuration element as a `float`.
public int	Returns: the value getValueAsInteger() Implements org.apache.avalon.framework.configuration.Configuration.getValueAsInteger. Returns the value of the configuration element as an `int`.
public int	Returns: the value getValueAsInteger(final int the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getValueAsInteger. Returns the value of the configuration element as an `int`.
public long	Returns: the value getValueAsLong() Implements org.apache.avalon.framework.configuration.Configuration.getValueAsLong. Returns the value of the configuration element as a `long`.
public long	Returns: the value getValueAsLong(final long the default value to return if value malformed or empty defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getValueAsLong. Returns the value of the configuration element as a `long`.
private boolean	isFalse(final String value)
private boolean	isTrue(final String value)
public String	Returns: getName() + "::" + getValue() + ":@" + getLocation(); toString() Overrides java.lang.Object.toString. The toString() operation is used for debugging information.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

AbstractConfiguration	back to summary
public AbstractConfiguration()

Method Detail

getAttribute back to summary

getAttribute	back to summary
public String getAttribute(final String name, final String defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttribute. Returns the value of the attribute specified by its name as a `String`. Parameters name:String the name of the attribute defaultValue:String the default value to return if value malformed or empty Returns:String the value

public String getAttribute(final String name, final String defaultValue)

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

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

Parameters

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

Returns:String

the value

getAttributeAsBoolean back to summary

getAttributeAsBoolean	back to summary
public boolean getAttributeAsBoolean(final String name) throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsBoolean. Returns the value of the attribute specified by its name as a `boolean`. Parameters name:String the name of the attribute Returns:boolean the value Exceptions ConfigurationException: if an error occurs

public boolean getAttributeAsBoolean(final String name) throws ConfigurationException

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

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

Parameters

name:String: the name of the attribute

Returns:boolean

the value

Exceptions

ConfigurationException:: if an error occurs

getAttributeAsBoolean back to summary

getAttributeAsBoolean	back to summary
public boolean getAttributeAsBoolean(final String name, final boolean defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsBoolean. Returns the value of the attribute specified by its name as a `boolean`. Parameters name:String the name of the attribute defaultValue:boolean the default value to return if value malformed or empty Returns:boolean the value

public boolean getAttributeAsBoolean(final String name, final boolean defaultValue)

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

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

Parameters

name:String: the name of the attribute
defaultValue:boolean: the default value to return if value malformed or empty

Returns:boolean

the value

getAttributeAsDouble back to summary

getAttributeAsDouble	back to summary
public double getAttributeAsDouble(final String name) throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsDouble. Returns the value of the attribute specified by its name as a `double`. Parameters name:String the name of the attribute Returns:double the value Exceptions ConfigurationException: if an error occurs

public double getAttributeAsDouble(final String name) throws ConfigurationException

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

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

Parameters

name:String: the name of the attribute

Returns:double

the value

Exceptions

ConfigurationException:: if an error occurs

getAttributeAsDouble back to summary

getAttributeAsDouble	back to summary
public double getAttributeAsDouble(final String name, final double defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsDouble. Returns the value of the attribute specified by its name as a `double`. Parameters name:String the name of the attribute defaultValue:double the default value to return if value malformed or empty Returns:double the value

public double getAttributeAsDouble(final String name, final double defaultValue)

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

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

Parameters

name:String: the name of the attribute
defaultValue:double: the default value to return if value malformed or empty

Returns:double

the value

getAttributeAsFloat back to summary

getAttributeAsFloat	back to summary
public float getAttributeAsFloat(final String name) throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsFloat. Returns the value of the attribute specified by its name as a `float`. Parameters name:String the name of the attribute Returns:float the value Exceptions ConfigurationException: if an error occurs

public float getAttributeAsFloat(final String name) throws ConfigurationException

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

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

Parameters

name:String: the name of the attribute

Returns:float

the value

Exceptions

ConfigurationException:: if an error occurs

getAttributeAsFloat back to summary

getAttributeAsFloat	back to summary
public float getAttributeAsFloat(final String name, final float defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsFloat. Returns the value of the attribute specified by its name as a `float`. Parameters name:String the name of the attribute defaultValue:float the default value to return if value malformed or empty Returns:float the value

public float getAttributeAsFloat(final String name, final float defaultValue)

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

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

Parameters

name:String: the name of the attribute
defaultValue:float: the default value to return if value malformed or empty

Returns:float

the value

getAttributeAsInteger back to summary

getAttributeAsInteger	back to summary
public int getAttributeAsInteger(final String name) throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsInteger. Returns the value of the attribute specified by its name as an `int`. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal. Parameters name:String the name of the attribute Returns:int the value Exceptions ConfigurationException: if an error occurs

public int getAttributeAsInteger(final String name) throws ConfigurationException

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

Returns the value of the attribute specified by its name as an int. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.

Parameters

name:String: the name of the attribute

Returns:int

the value

Exceptions

ConfigurationException:: if an error occurs

getAttributeAsInteger back to summary

getAttributeAsInteger	back to summary
public int getAttributeAsInteger(final String name, final int defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsInteger. Returns the value of the attribute specified by its name as an `int`. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal. Parameters name:String the name of the attribute defaultValue:int the default value to return if value malformed or empty Returns:int the value

public int getAttributeAsInteger(final String name, final int defaultValue)

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

Parameters

name:String: the name of the attribute
defaultValue:int: the default value to return if value malformed or empty

Returns:int

the value

getAttributeAsLong back to summary

getAttributeAsLong	back to summary
public long getAttributeAsLong(final String name) throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsLong. Returns the value of the attribute specified by its name as a `long`. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal. Parameters name:String the name of the attribute Returns:long the value Exceptions ConfigurationException: if an error occurs

public long getAttributeAsLong(final String name) throws ConfigurationException

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

Returns the value of the attribute specified by its name as a long. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.

Parameters

name:String: the name of the attribute

Returns:long

the value

Exceptions

ConfigurationException:: if an error occurs

getAttributeAsLong back to summary

getAttributeAsLong	back to summary
public long getAttributeAsLong(final String name, final long defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getAttributeAsLong. Returns the value of the attribute specified by its name as a `long`. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal. Parameters name:String the name of the attribute defaultValue:long the default value to return if value malformed or empty Returns:long the value

public long getAttributeAsLong(final String name, final long defaultValue)

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

Parameters

name:String: the name of the attribute
defaultValue:long: the default value to return if value malformed or empty

Returns:long

the value

getChild back to summary

getChild	back to summary
public Configuration getChild(final String name) Implements org.apache.avalon.framework.configuration.Configuration.getChild. Return the first `Configuration` object child of this associated with the given name. If no such child exists, a new one will be created. Parameters name:String the name of the child Returns:Configuration the child Configuration

public Configuration getChild(final String name)

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

Return the first Configuration object child of this associated with the given name. If no such child exists, a new one will be created.

Parameters

name:String: the name of the child

Returns:Configuration

the child Configuration

getChild back to summary

getChild	back to summary
public Configuration getChild(final String name, final boolean createNew) Implements org.apache.avalon.framework.configuration.Configuration.getChild. Return the first `Configuration` object child of this associated with the given name. Parameters name:String the name of the child createNew:boolean true if you want to create a new Configuration object if none exists Returns:Configuration the child Configuration

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

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

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

Parameters

name:String: the name of the child
createNew:boolean: true if you want to create a new Configuration object if none exists

Returns:Configuration

the child Configuration

getPrefix back to summary

getPrefix	back to summary
protected abstract String getPrefix() throws ConfigurationException Returns 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:String A non-null String (defaults to "") Exceptions ConfigurationException: if no prefix was defined (prefix is `null`. Since 4.1

protected abstract String getPrefix() throws ConfigurationException

Returns 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:String

A non-null String (defaults to "")

Exceptions

ConfigurationException:: if no prefix was defined (prefix is null.

Since

4.1

getValue back to summary

getValue	back to summary
public String getValue(final String defaultValue) 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 the value

public String getValue(final String defaultValue)

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

the value

getValueAsBoolean back to summary

getValueAsBoolean	back to summary
public boolean getValueAsBoolean() throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getValueAsBoolean. Returns the value of the configuration element as a `boolean`. Returns:boolean the value Exceptions ConfigurationException: if an error occurs

public boolean getValueAsBoolean() throws ConfigurationException

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

Returns the value of the configuration element as a boolean.

Returns:boolean

the value

Exceptions

ConfigurationException:: if an error occurs

getValueAsBoolean back to summary

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

public boolean getValueAsBoolean(final boolean defaultValue)

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

Returns the value of the configuration element as a boolean.

Parameters

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

Returns:boolean

the value

getValueAsDouble back to summary

getValueAsDouble	back to summary
public double getValueAsDouble() throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getValueAsDouble. Returns the value of the configuration element as a `double`. Returns:double the value Exceptions ConfigurationException: if an error occurs

public double getValueAsDouble() throws ConfigurationException

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

Returns the value of the configuration element as a double.

Returns:double

the value

Exceptions

ConfigurationException:: if an error occurs

getValueAsDouble back to summary

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

public double getValueAsDouble(final double defaultValue)

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

Returns the value of the configuration element as a double.

Parameters

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

Returns:double

the value

getValueAsFloat back to summary

getValueAsFloat	back to summary
public float getValueAsFloat() throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getValueAsFloat. Returns the value of the configuration element as a `float`. Returns:float the value Exceptions ConfigurationException: if an error occurs

public float getValueAsFloat() throws ConfigurationException

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

Returns the value of the configuration element as a float.

Returns:float

the value

Exceptions

ConfigurationException:: if an error occurs

getValueAsFloat back to summary

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

public float getValueAsFloat(final float defaultValue)

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

Returns the value of the configuration element as a float.

Parameters

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

Returns:float

the value

getValueAsInteger back to summary

getValueAsInteger	back to summary
public int getValueAsInteger() throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getValueAsInteger. Returns the value of the configuration element as an `int`. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal. Returns:int the value Exceptions ConfigurationException: if an error occurs

public int getValueAsInteger() throws ConfigurationException

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

Returns the value of the configuration element as an int. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.

Returns:int

the value

Exceptions

ConfigurationException:: if an error occurs

getValueAsInteger back to summary

getValueAsInteger	back to summary
public int getValueAsInteger(final int defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getValueAsInteger. Returns the value of the configuration element as an `int`. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal. Parameters defaultValue:int the default value to return if value malformed or empty Returns:int the value

public int getValueAsInteger(final int defaultValue)

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

Parameters

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

Returns:int

the value

getValueAsLong back to summary

getValueAsLong	back to summary
public long getValueAsLong() throws ConfigurationException Implements org.apache.avalon.framework.configuration.Configuration.getValueAsLong. Returns the value of the configuration element as a `long`. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal. Returns:long the value Exceptions ConfigurationException: if an error occurs

public long getValueAsLong() throws ConfigurationException

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

Returns the value of the configuration element as a long. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal.

Returns:long

the value

Exceptions

ConfigurationException:: if an error occurs

getValueAsLong back to summary

getValueAsLong	back to summary
public long getValueAsLong(final long defaultValue) Implements org.apache.avalon.framework.configuration.Configuration.getValueAsLong. Returns the value of the configuration element as a `long`. Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary numbers begin with 0b, all other values are assumed to be decimal. Parameters defaultValue:long the default value to return if value malformed or empty Returns:long the value

public long getValueAsLong(final long defaultValue)

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

Parameters

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

Returns:long

the value

isFalse	back to summary
private boolean isFalse(final String value)

isTrue	back to summary
private boolean isTrue(final String value)

toString	back to summary
public String toString() Overrides java.lang.Object.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. Returns:String getName() + "::" + getValue() + ":@" + getLocation();

toString

back to summary

public String toString()

Overrides java.lang.Object.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.

Returns:String: getName() + "::" + getValue() + ":@" + getLocation();

public abstract Class AbstractConfiguration

Constructor Summary

Method Summary

Constructor Detail

Method Detail