Interface MutableConfiguration

All Superinterfaces:
org.apache.avalon.framework.configuration.Configuration
All Known Implementing Classes:
DefaultConfiguration
public interface MutableConfiguration extends org.apache.avalon.framework.configuration.Configuration
A read/write extension of the Configuration interface.
Since:
4.1.6
Version:
$Id: MutableConfiguration.java 156533 2005-03-08 08:51:40 -0600 (Tue, 08 Mar 2005) leif $
Author:
Avalon Development Team

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAll(org.apache.avalon.framework.configuration.Configuration other)
    Add all the attributes, children and value from specified configuration element to current configuration element.
    void
    addAllAttributes(org.apache.avalon.framework.configuration.Configuration other)
    Add all attributes from specified configuration element to current configuration element.
    void
    addAllChildren(org.apache.avalon.framework.configuration.Configuration other)
    Add all child Configuration objects from specified configuration element to current configuration element.
    void
    addChild(org.apache.avalon.framework.configuration.Configuration configuration)
    Add a child Configuration to this configuration element.
    MutableConfiguration
    getMutableChild(String name)
    Equivalent to getMutableChild( name, true )
    MutableConfiguration
    getMutableChild(String name, boolean autoCreate)
    Gets a child node of this configuration.
    MutableConfiguration[]
    getMutableChildren()
    Returns an array of mutable children.
    MutableConfiguration[]
    getMutableChildren(String name)
    Returns an array of mutable children with the given name.
    void
    removeChild(org.apache.avalon.framework.configuration.Configuration configuration)
    Remove a child Configuration to this configuration element.
    void
    setAttribute(String name, boolean value)
    Set the value of the specified attribute to the specified boolean.
    void
    setAttribute(String name, double value)
    Set the value of the specified attribute to the specified double.
    void
    setAttribute(String name, float value)
    Set the value of the specified attribute to the specified float.
    void
    setAttribute(String name, int value)
    Set the value of the specified attribute to the specified int.
    void
    setAttribute(String name, long value)
    Set the value of the specified attribute to the specified long.
    void
    setAttribute(String name, String value)
    Set the value of the specified attribute to the specified string.
    void
    setValue(boolean value)
    Set the value of this Configuration object to the specified boolean.
    void
    setValue(double value)
    Set the value of this Configuration object to the specified double.
    void
    setValue(float value)
    Set the value of this Configuration object to the specified float.
    void
    setValue(int value)
    Set the value of this Configuration object to the specified int.
    void
    setValue(long value)
    Set the value of this Configuration object to the specified long.
    void
    setValue(String value)
    Set the value of this Configuration object to the specified string.

    Methods inherited from interface org.apache.avalon.framework.configuration.Configuration

    getAttribute, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsFloat, getAttributeAsInteger, getAttributeAsInteger, getAttributeAsLong, getAttributeAsLong, getAttributeNames, getChild, getChild, getChildren, getChildren, getLocation, getName, getNamespace, getValue, getValue, getValueAsBoolean, getValueAsBoolean, getValueAsDouble, getValueAsDouble, getValueAsFloat, getValueAsFloat, getValueAsInteger, getValueAsInteger, getValueAsLong, getValueAsLong

  • Method Details

    • setValue

      void setValue(String value)
      Set the value of this Configuration object to the specified string.
      Parameters:
      value - a String value

    • setValue

      void setValue(int value)
      Set the value of this Configuration object to the specified int.
      Parameters:
      value - a int value

    • setValue

      void setValue(long value)
      Set the value of this Configuration object to the specified long.
      Parameters:
      value - a long value

    • setValue

      void setValue(boolean value)
      Set the value of this Configuration object to the specified boolean.
      Parameters:
      value - a boolean value

    • setValue

      void setValue(float value)
      Set the value of this Configuration object to the specified float.
      Parameters:
      value - a float value

    • setValue

      void setValue(double value)
      Set the value of this Configuration object to the specified double.
      Parameters:
      value - a double value

    • setAttribute

      void setAttribute(String name, String value)
      Set the value of the specified attribute to the specified string.
      Parameters:
      name - name of the attribute to set
      value - a String value. If null, the attribute is removed.

    • setAttribute

      void setAttribute(String name, int value)
      Set the value of the specified attribute to the specified int.
      Parameters:
      name - name of the attribute to set
      value - an int value

    • setAttribute

      void setAttribute(String name, long value)
      Set the value of the specified attribute to the specified long.
      Parameters:
      name - name of the attribute to set
      value - an long value

    • setAttribute

      void setAttribute(String name, boolean value)
      Set the value of the specified attribute to the specified boolean.
      Parameters:
      name - name of the attribute to set
      value - an boolean value

    • setAttribute

      void setAttribute(String name, float value)
      Set the value of the specified attribute to the specified float.
      Parameters:
      name - name of the attribute to set
      value - an float value

    • setAttribute

      void setAttribute(String name, double value)
      Set the value of the specified attribute to the specified double.
      Parameters:
      name - name of the attribute to set
      value - an double value

    • addChild

      void addChild(org.apache.avalon.framework.configuration.Configuration configuration)
      Add a child Configuration to this configuration element.
      Parameters:
      configuration - a Configuration value

    • addAll

      void addAll(org.apache.avalon.framework.configuration.Configuration other)
      Add all the attributes, children and value from specified configuration element to current configuration element.
      Parameters:
      other - the Configuration element

    • addAllAttributes

      void addAllAttributes(org.apache.avalon.framework.configuration.Configuration other)
      Add all attributes from specified configuration element to current configuration element.
      Parameters:
      other - the Configuration element

    • addAllChildren

      void addAllChildren(org.apache.avalon.framework.configuration.Configuration other)
      Add all child Configuration objects from specified configuration element to current configuration element.
      Parameters:
      other - the other Configuration value

    • removeChild

      void removeChild(org.apache.avalon.framework.configuration.Configuration configuration)
      Remove a child Configuration to this configuration element.
      Parameters:
      configuration - a Configuration value

    • getMutableChild

      MutableConfiguration getMutableChild(String name) throws org.apache.avalon.framework.configuration.ConfigurationException
      Equivalent to getMutableChild( name, true )
      Throws:
      org.apache.avalon.framework.configuration.ConfigurationException

    • getMutableChild

      MutableConfiguration getMutableChild(String name, boolean autoCreate) throws org.apache.avalon.framework.configuration.ConfigurationException
      Gets a child node of this configuration. If a mutable child with the given name exists, it is returned. If an immutable child with the given name exists, it is converted into a mutable child and returned. In this case, the immutable child will be replaced with the mutable child in this configuration (that is, it will be as if the child node always had been mutable). If no child with the given name exists, and autoCreate is true, a new mutable child is created and added to this configuration before being returned.
      Parameters:
      name - the name of the child.
      autoCreate - set to true to create the child node if it doesn't exist.
      Returns:
      the child MutableConfiguration, or null if autoCreate was false and no child by the given name existed.
      Throws:
      org.apache.avalon.framework.configuration.ConfigurationException - if an error occurrs.

    • getMutableChildren

      MutableConfiguration[] getMutableChildren() throws org.apache.avalon.framework.configuration.ConfigurationException
      Returns an array of mutable children. Immutable children are converted just as for getMutableChild.
      Throws:
      org.apache.avalon.framework.configuration.ConfigurationException - if an error occurrs.

    • getMutableChildren

      MutableConfiguration[] getMutableChildren(String name) throws org.apache.avalon.framework.configuration.ConfigurationException
      Returns an array of mutable children with the given name. Immutable children are converted just as for getMutableChild.
      Throws:
      org.apache.avalon.framework.configuration.ConfigurationException - if an error occurrs.