Configurable.java

/**
 *
 * 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.bookkeeper.conf;

import org.apache.commons.configuration.Configuration;

import com.google.common.annotations.Beta;

/**
 * Class that may be configured with a {@link Configuration}.
 */
@Beta
public interface Configurable {

    /**
     * Set the configuration to be used by this object.
     *
     * @param conf
     *          Configuration object to use
     */
    public void setConf(Configuration conf);

    /**
     * Return the configuration used by this object.
     *
     * @return configuration used by this object.
     */
    public Configuration getConf();
}