Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ReloadingStrategy |
|
| 1.0;1 |
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 | * @author Olivier Heger | |
27 | * @version $Revision: 439648 $, $Date: 2006-09-02 22:42:10 +0200 (Sa, 02 Sep 2006) $ | |
28 | * @since 1.1 | |
29 | */ | |
30 | public interface ReloadingStrategy | |
31 | { | |
32 | /** | |
33 | * Set the configuration managed by this strategy. | |
34 | * | |
35 | * @param configuration the configuration to monitor | |
36 | */ | |
37 | void setConfiguration(FileConfiguration configuration); | |
38 | ||
39 | /** | |
40 | * Initialize the strategy. | |
41 | */ | |
42 | void init(); | |
43 | ||
44 | /** | |
45 | * Tell if the evaluation of the strategy requires to reload the configuration. | |
46 | * | |
47 | * @return a flag whether a reload should be performed | |
48 | */ | |
49 | boolean reloadingRequired(); | |
50 | ||
51 | /** | |
52 | * Notify the strategy that the file has been reloaded. | |
53 | */ | |
54 | void reloadingPerformed(); | |
55 | ||
56 | } |