001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  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
018package org.apache.commons.configuration.reloading;
019
020import org.apache.commons.configuration.FileConfiguration;
021
022/**
023 * A strategy to decide if a configuration should be reloaded.
024 *
025 * @author Emmanuel Bourg
026 * @version $Id: ReloadingStrategy.html 901729 2014-03-15 20:24:09Z oheger $
027 * @since 1.1
028 */
029public interface ReloadingStrategy
030{
031    /**
032     * Set the configuration managed by this strategy.
033     *
034     * @param configuration the configuration to monitor
035     */
036    void setConfiguration(FileConfiguration configuration);
037
038    /**
039     * Initialize the strategy.
040     */
041    void init();
042
043    /**
044     * Tell if the evaluation of the strategy requires to reload the configuration.
045     *
046     * @return a flag whether a reload should be performed
047     */
048    boolean reloadingRequired();
049
050    /**
051     * Notify the strategy that the file has been reloaded.
052     */
053    void reloadingPerformed();
054
055}