001 package org.apache.ojb.broker.util.configuration;
002
003 /* Copyright 2002-2005 The Apache Software Foundation
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018 /**
019 * This interface defines the behaviour of a configurable Object.
020 * It provides a single callback method configure(Configuration pConfig).
021 * This method is invoked by a <code>Configurator</code>.
022 * Implementors of this method evaluate the Configuration object pConfig
023 * to perform the proper configuration of the current instance.
024 *
025 * @author Thomas Mahler
026 * @version $Id: Configurable.java,v 1.1 2007-08-24 22:17:30 ewestfal Exp $
027 */
028 public interface Configurable
029 {
030
031 /**
032 * configure an object using the Configuration pConfig
033 * @param pConfig the Configuration object used to configure current instance
034 * @throws ConfigurationException
035 */
036 void configure(Configuration pConfig) throws ConfigurationException;
037
038 }