http://www.apache.org/excalibur/avalon-framework/avalon-framework-api/: Avalon Framework API (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;


This interface should be implemented by classes that need to be
configured with custom parameters before initialization.


The contract surrounding a Configurable is that the
instantiating entity must call the configure
method before it is valid. 


Note that this interface is incompatible with Parameterizable.

Author:Avalon Development Team
Version:$Id: Configurable.java 506231 2007-02-12 02:36:54Z crossley $
/**
 * This interface should be implemented by classes that need to be
 * configured with custom parameters before initialization.
 * <br/>
 *
 * The contract surrounding a <code>Configurable</code> is that the
 * instantiating entity must call the <code>configure</code>
 * method before it is valid. 
 * <br/>
 *
 * Note that this interface is incompatible with Parameterizable.
 *
 * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
 * @version $Id: Configurable.java 506231 2007-02-12 02:36:54Z crossley $
 */
public interface Configurable
{
    
Pass the Configuration to the Configurable
class. 

Params:
  • configuration – the class configurations. Must not be null.
Throws:
/**
     * Pass the <code>Configuration</code> to the <code>Configurable</code>
     * class. 
     *
     * @param configuration the class configurations. Must not be <code>null</code>.
     * @throws ConfigurationException if an error occurs
     */
    void configure( Configuration configuration )
        throws ConfigurationException;
}