View Javadoc

1   /*
2    * Copyright 2001-2005 The Apache Software Foundation.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License")
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.commons.configuration.reloading;
18  
19  import org.apache.commons.configuration.FileConfiguration;
20  
21  /***
22   * A strategy to decide if a configuration should be reloaded.
23   *
24   * @author Emmanuel Bourg
25   * @author Olivier Heger
26   * @version $Revision$, $Date: 2005-10-10 21:26:46 +0200 (Mon, 10 Oct 2005) $
27   * @since 1.1
28   */
29  public interface ReloadingStrategy
30  {
31      /***
32       * Set the configuration managed by this strategy.
33       *
34       * @param configuration the configuration to monitor
35       */
36      void setConfiguration(FileConfiguration configuration);
37  
38      /***
39       * Initialize the strategy.
40       */
41      void init();
42  
43      /***
44       * Tell if the evaluation of the strategy requires to reload the configuration.
45       *
46       * @return a flag whether a reload should be performed
47       */
48      boolean reloadingRequired();
49  
50      /***
51       * Notify the strategy that the file has been reloaded.
52       */
53      void reloadingPerformed();
54  
55  }