You are viewing a plain text version of this content. The canonical link for it is here.

Posted to cvs@avalon.apache.org by le...@apache.org on 2004/01/29 17:27:39 UTC

cvs commit: avalon/framework/api/src/java/org/apache/avalon/framework/configuration MutableConfiguration.java

leosutic    2004/01/29 08:27:39

  Added:       framework/api/src/java/org/apache/avalon/framework/configuration
                        MutableConfiguration.java
  Log:
  Added a MutableConfiguration interface.
  
  Revision  Changes    Path
  1.1                  avalon/framework/api/src/java/org/apache/avalon/framework/configuration/MutableConfiguration.java
  
  Index: MutableConfiguration.java
  ===================================================================
  /*
   * Copyright 1997-2004 Apache Software Foundation
   * 
   * Licensed 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 <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
   * @version CVS $Revision: 1.1 $ $Date: 2004/01/29 16:27:39 $
   */
  public interface MutableConfiguration extends Configuration
  {
      /**
       * 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 <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 <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 <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 <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 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.
       *
       * @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.
       *
       * @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.
       *
       * @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.
       *
       * @param name name of the attribute to set
       * @param value an <code>float</code> value
       */
      public void setAttribute( final String name, final float 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.
       *
       * @param other the {@link Configuration} element
       */
      public void addAll( final Configuration other );
  
      /**
       * 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 <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 <code>Configuration</code> to this configuration element.
       * @param configuration a <code>Configuration</code> value
       */
      public void removeChild( final Configuration configuration );
      
      /**
       * 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 <code>autoCreate</code> 
       * is <code>true</code>, a new mutable child is created and added to 
       * this configuration before being returned.
       *
       * @returns 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 <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 <code>getMutableChild</code>.
       * @throws ConfigurationException if an error occurrs.
       */
      public MutableConfiguration[] getMutableChildren( final String name ) throws ConfigurationException;
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org

Re: cvs commit: avalon/framework/api/src/java/org/apache/avalon/framework/configuration MutableConfiguration.java

Posted by Leo Simons <le...@apache.org>.

Niclas Hedhman wrote:
>  proper due process.

bleh. Let's not let ourself get hampered by "proper due process" unless 
its got something to do with "due diligence", legalities, or anything 
like that. Let's focus on getting work done.

-- 
cheers,

- Leo Simons

-----------------------------------------------------------------------
Weblog              -- http://leosimons.com/
IoC Component Glue  -- http://jicarilla.org/
Articles & Opinions -- http://articles.leosimons.com/
-----------------------------------------------------------------------
"We started off trying to set up a small anarchist community, but
  people wouldn't obey the rules."
                                                         -- Alan Bennett



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@avalon.apache.org
For additional commands, e-mail: dev-help@avalon.apache.org