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  package org.apache.commons.configuration2.reloading;
18  
19  /**
20   * <p>
21   * Definition of an interface to be implemented by components which support reloading operations managed by a
22   * {@link ReloadingController}.
23   * </p>
24   * <p>
25   * Classes implementing this interface have to provide access to a {@link ReloadingController} instance. This object can
26   * then be used to trigger reloading checks.
27   * </p>
28   *
29   * @since 2.0
30   */
31  public interface ReloadingControllerSupport {
32      /**
33       * Gets the {@code ReloadingController} associated with this object.
34       *
35       * @return the associated {@code ReloadingController}
36       */
37      ReloadingController getReloadingController();
38  }