Package org.apache.avalon.framework.configuration

Class AbstractConfiguration

java.lang.Object
org.apache.avalon.framework.configuration.AbstractConfiguration
All Implemented Interfaces:
Configuration
Direct Known Subclasses:
DefaultConfiguration, DefaultImmutableConfiguration
public abstract class AbstractConfiguration extends Object implements Configuration
This is an abstract Configuration implementation that deals with methods that can be abstracted away from underlying implementations.
Version:
CVS $Revision: 1.31 $ $Date: 2004/02/11 14:34:25 $
Author:
Avalon Development Team

  • Constructor Details

    • AbstractConfiguration

      public AbstractConfiguration()

  • Method Details

    • getPrefix

      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:
      A non-null String (defaults to "")
      Throws:
      ConfigurationException - if no prefix was defined (prefix is null.
      Since:
      4.1

    • getValueAsInteger

      public int getValueAsInteger() throws ConfigurationException
      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.
      Specified by:
      getValueAsInteger in interface Configuration
      Returns:
      the value
      Throws:
      ConfigurationException - if an error occurs

    • getValueAsInteger

      public int getValueAsInteger(int defaultValue)
      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.
      Specified by:
      getValueAsInteger in interface Configuration
      Parameters:
      defaultValue - the default value to return if value malformed or empty
      Returns:
      the value

    • getValueAsLong

      public long getValueAsLong() throws ConfigurationException
      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.
      Specified by:
      getValueAsLong in interface Configuration
      Returns:
      the value
      Throws:
      ConfigurationException - if an error occurs

    • getValueAsLong

      public long getValueAsLong(long defaultValue)
      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.
      Specified by:
      getValueAsLong in interface Configuration
      Parameters:
      defaultValue - the default value to return if value malformed or empty
      Returns:
      the value

    • getValueAsFloat

      public float getValueAsFloat() throws ConfigurationException
      Returns the value of the configuration element as a float.
      Specified by:
      getValueAsFloat in interface Configuration
      Returns:
      the value
      Throws:
      ConfigurationException - if an error occurs

    • getValueAsFloat

      public float getValueAsFloat(float defaultValue)
      Returns the value of the configuration element as a float.
      Specified by:
      getValueAsFloat in interface Configuration
      Parameters:
      defaultValue - the default value to return if value malformed or empty
      Returns:
      the value

    • getValueAsBoolean

      public boolean getValueAsBoolean() throws ConfigurationException
      Returns the value of the configuration element as a boolean.
      Specified by:
      getValueAsBoolean in interface Configuration
      Returns:
      the value
      Throws:
      ConfigurationException - if an error occurs

    • getValueAsBoolean

      public boolean getValueAsBoolean(boolean defaultValue)
      Returns the value of the configuration element as a boolean.
      Specified by:
      getValueAsBoolean in interface Configuration
      Parameters:
      defaultValue - the default value to return if value malformed or empty
      Returns:
      the value

    • getValue

      public String getValue(String defaultValue)
      Returns the value of the configuration element as a String.
      Specified by:
      getValue in interface Configuration
      Parameters:
      defaultValue - the default value to return if value malformed or empty
      Returns:
      the value

    • getAttributeAsInteger

      public int getAttributeAsInteger(String name) throws ConfigurationException
      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.
      Specified by:
      getAttributeAsInteger in interface Configuration
      Parameters:
      name - the name of the attribute
      Returns:
      the value
      Throws:
      ConfigurationException - if an error occurs

    • getAttributeAsInteger

      public int getAttributeAsInteger(String name, int defaultValue)
      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.
      Specified by:
      getAttributeAsInteger in interface Configuration
      Parameters:
      name - the name of the attribute
      defaultValue - the default value to return if value malformed or empty
      Returns:
      the value

    • getAttributeAsLong

      public long getAttributeAsLong(String name) throws ConfigurationException
      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.
      Specified by:
      getAttributeAsLong in interface Configuration
      Parameters:
      name - the name of the attribute
      Returns:
      the value
      Throws:
      ConfigurationException - if an error occurs

    • getAttributeAsLong

      public long getAttributeAsLong(String name, long defaultValue)
      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.
      Specified by:
      getAttributeAsLong in interface Configuration
      Parameters:
      name - the name of the attribute
      defaultValue - the default value to return if value malformed or empty
      Returns:
      the value

    • getAttributeAsFloat

      public float getAttributeAsFloat(String name) throws ConfigurationException
      Returns the value of the attribute specified by its name as a float.
      Specified by:
      getAttributeAsFloat in interface Configuration
      Parameters:
      name - the name of the attribute
      Returns:
      the value
      Throws:
      ConfigurationException - if an error occurs

    • getAttributeAsFloat

      public float getAttributeAsFloat(String name, float defaultValue)
      Returns the value of the attribute specified by its name as a float.
      Specified by:
      getAttributeAsFloat in interface Configuration
      Parameters:
      name - the name of the attribute
      defaultValue - the default value to return if value malformed or empty
      Returns:
      the value

    • getAttributeAsBoolean

      public boolean getAttributeAsBoolean(String name) throws ConfigurationException
      Returns the value of the attribute specified by its name as a boolean.
      Specified by:
      getAttributeAsBoolean in interface Configuration
      Parameters:
      name - the name of the attribute
      Returns:
      the value
      Throws:
      ConfigurationException - if an error occurs

    • getAttributeAsBoolean

      public boolean getAttributeAsBoolean(String name, boolean defaultValue)
      Returns the value of the attribute specified by its name as a boolean.
      Specified by:
      getAttributeAsBoolean in interface Configuration
      Parameters:
      name - the name of the attribute
      defaultValue - the default value to return if value malformed or empty
      Returns:
      the value

    • getAttribute

      public String getAttribute(String name, String defaultValue)
      Returns the value of the attribute specified by its name as a String.
      Specified by:
      getAttribute in interface Configuration
      Parameters:
      name - the name of the attribute
      defaultValue - the default value to return if value malformed or empty
      Returns:
      the value

    • getChild

      public Configuration getChild(String name)
      Return the first Configuration object child of this associated with the given name. If no such child exists, a new one will be created.
      Specified by:
      getChild in interface Configuration
      Parameters:
      name - the name of the child
      Returns:
      the child Configuration

    • getChild

      public Configuration getChild(String name, boolean createNew)
      Return the first Configuration object child of this associated with the given name.
      Specified by:
      getChild in interface Configuration
      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

    • toString

      public String 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.
      Overrides:
      toString in class Object
      Returns:
      getName() + "::" + getValue() + ":@" + getLocation();