View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.configuration.reloading;
19  
20  import org.apache.commons.configuration.FileConfiguration;
21  
22  /**
23   * A strategy to decide if a configuration should be reloaded.
24   *
25   * @author Emmanuel Bourg
26   * @version $Id: ReloadingStrategy.java 1210646 2011-12-05 21:25:01Z oheger $
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  }