http://www.apache.org/excalibur/avalon-framework/avalon-framework-impl/: Avalon Framework Implementation (Apache Software Foundation) 
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.avalon.framework.configuration;


A read/write extension of the Configuration interface.

Author:Avalon Development Team
Version:$Id: MutableConfiguration.java 506231 2007-02-12 02:36:54Z crossley $
Since:4.1.6
/**
 * A read/write extension of the Configuration interface.
 *
 * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
 * @version $Id: MutableConfiguration.java 506231 2007-02-12 02:36:54Z crossley $
 * @since 4.1.6
 */
public interface MutableConfiguration extends Configuration
{
    
Set the value of this Configuration object to the specified string.

Params:
  • value – a String value
/**
     * Set the value of this <code>Configuration</code> object to the specified string.
     *
     * @param value a <code>String</code> value
     */
    public void setValue( final String value );
    
    
Set the value of this Configuration object to the specified int.

Params:
  • value – a int value
/**
     * Set the value of this <code>Configuration</code> object to the specified int.
     *
     * @param value a <code>int</code> value
     */
    public void setValue( final int value );
    
    
Set the value of this Configuration object to the specified long.

Params:
  • value – a long value
/**
     * Set the value of this <code>Configuration</code> object to the specified long.
     *
     * @param value a <code>long</code> value
     */
    public void setValue( final long value );
    
    
Set the value of this Configuration object to the specified boolean.

Params:
  • value – a boolean value
/**
     * Set the value of this <code>Configuration</code> object to the specified boolean.
     *
     * @param value a <code>boolean</code> value
     */
    public void setValue( final boolean value );
    
    
Set the value of this Configuration object to the specified float.

Params:
  • value – a float value
/**
     * Set the value of this <code>Configuration</code> object to the specified float.
     *
     * @param value a <code>float</code> value
     */
    public void setValue( final float value );
    
    
Set the value of this Configuration object to the specified double.

Params:
  • value – a double value
/**
     * Set the value of this <code>Configuration</code> object to the specified double.
     *
     * @param value a <code>double</code> value
     */
    public void setValue( final double value );
    
    
Set the value of the specified attribute to the specified string.

Params:
  • name – name of the attribute to set
  • value – a String value. If null, the attribute is removed.
/**
     * Set the value of the specified attribute to the specified string.
     *
     * @param name name of the attribute to set
     * @param value a <code>String</code> value. If null, the attribute is removed.
     */
    public void setAttribute( final String name, final String value );
    
    
Set the value of the specified attribute to the specified int.

Params:
  • name – name of the attribute to set
  • value – an int value
/**
     * Set the value of the specified attribute to the specified int.
     *
     * @param name name of the attribute to set
     * @param value an <code>int</code> value
     */
    public void setAttribute( final String name, final int value );
    
    
Set the value of the specified attribute to the specified long.

Params:
  • name – name of the attribute to set
  • value – an long value
/**
     * Set the value of the specified attribute to the specified long.
     *
     * @param name name of the attribute to set
     * @param value an <code>long</code> value
     */
    public void setAttribute( final String name, final long value );
    
    
Set the value of the specified attribute to the specified boolean.

Params:
  • name – name of the attribute to set
  • value – an boolean value
/**
     * Set the value of the specified attribute to the specified boolean.
     *
     * @param name name of the attribute to set
     * @param value an <code>boolean</code> value
     */
    public void setAttribute( final String name, final boolean value );
    
    
Set the value of the specified attribute to the specified float.

Params:
  • name – name of the attribute to set
  • value – an float value
/**
     * Set the value of the specified attribute to the specified float.
     *
     * @param name name of the attribute to set
     * @param value an <code>float</code> value
     */
    public void setAttribute( final String name, final float value );
    
    
Set the value of the specified attribute to the specified double.

Params:
  • name – name of the attribute to set
  • value – an double value
/**
     * Set the value of the specified attribute to the specified double.
     *
     * @param name name of the attribute to set
     * @param value an <code>double</code> value
     */
    public void setAttribute( final String name, final double value );
    
    
Add a child Configuration to this configuration element.

Params:
  • configuration – a Configuration value
/**
     * Add a child <code>Configuration</code> to this configuration element.
     * @param configuration a <code>Configuration</code> value
     */
    public void addChild( final Configuration configuration );
    
    
Add all the attributes, children and value
from specified configuration element to current
configuration element.

Params:
/**
     * Add all the attributes, children and value
     * from specified configuration element to current
     * configuration element.
     *
     * @param other the {@link Configuration} element
     */
    public void addAll( final Configuration other );
    
    
Add all attributes from specified configuration
element to current configuration element.

Params:
/**
     * Add all attributes from specified configuration
     * element to current configuration element.
     *
     * @param other the {@link Configuration} element
     */
    public void addAllAttributes( final Configuration other );
    
    
Add all child Configuration objects from specified
configuration element to current configuration element.

Params:
/**
     * Add all child <code>Configuration</code> objects from specified
     * configuration element to current configuration element.
     *
     * @param other the other {@link Configuration} value
     */
    public void addAllChildren( final Configuration other );
    
    
Remove a child Configuration to this configuration element.

Params:
  • configuration – a Configuration value
/**
     * Remove a child <code>Configuration</code> to this configuration element.
     * @param configuration a <code>Configuration</code> value
     */
    public void removeChild( final Configuration configuration );
    
    
Equivalent to getMutableChild( name, true )

/**
     * Equivalent to <code>getMutableChild( name, true )</code>
     */
    public MutableConfiguration getMutableChild( final String name ) throws 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.

Params:
  • name – the name of the child.
  • autoCreate – set to true to create the child node if it doesn't exist.
Throws:
Returns:the child MutableConfiguration, or null if autoCreate
         was false and no child by the given name existed.
/**
     * 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 <code>autoCreate</code> 
     * is <code>true</code>, a new mutable child is created and added to 
     * this configuration before being returned.
     *
     * @return the child MutableConfiguration, or <code>null</code> if <code>autoCreate</code>
     *          was false and no child by the given name existed.
     * @param name the name of the child.
     * @param autoCreate set to true to create the child node if it doesn't exist.
     * @throws ConfigurationException if an error occurrs.
     */
    public MutableConfiguration getMutableChild( final String name, boolean autoCreate ) throws ConfigurationException;
    
    
Returns an array of mutable children. Immutable children
are converted just as for getMutableChild.

Throws:
  • ConfigurationException – if an error occurrs.
/**
     * Returns an array of mutable children. Immutable children
     * are converted just as for <code>getMutableChild</code>.
     * @throws ConfigurationException if an error occurrs.
     */
    public MutableConfiguration[] getMutableChildren() throws ConfigurationException;
    
    
Returns an array of mutable children with the given name. Immutable children
are converted just as for getMutableChild.

Throws:
  • ConfigurationException – if an error occurrs.
/**
     * Returns an array of mutable children with the given name. Immutable children
     * are converted just as for <code>getMutableChild</code>.
     * @throws ConfigurationException if an error occurrs.
     */
    public MutableConfiguration[] getMutableChildren( final String name ) throws ConfigurationException;
}