com.alibaba.antx.util.configuration.Configurable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of antx-autoconfig Show documentation

The newest version!

/*
 * Copyright (c) 2002-2012 Alibaba Group Holding Limited.
 * All rights reserved.
 *
 * 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 com.alibaba.antx.util.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
 */
public interface Configurable {
    /**
     * Pass the Configuration to the Configurable
     * class.
     *
     * @param configuration the class configurations. Must not be
     *                      null.
     * @throws ConfigurationException if an error occurs
     */
    void configure(Configuration configuration) throws ConfigurationException;
}