Source code
Description: source: package: org.apache.commons.configuration2.reloading, interface: ReloadingControllerSupport

    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 *     https://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 */
    017package org.apache.commons.configuration2.reloading;
    018
    019/**
    020 * <p>
    021 * Definition of an interface to be implemented by components which support reloading operations managed by a
    022 * {@link ReloadingController}.
    023 * </p>
    024 * <p>
    025 * Classes implementing this interface have to provide access to a {@link ReloadingController} instance. This object can
    026 * then be used to trigger reloading checks.
    027 * </p>
    028 *
    029 * @since 2.0
    030 */
    031public interface ReloadingControllerSupport {
    032
    033    /**
    034     * Gets the {@code ReloadingController} associated with this object.
    035     *
    036     * @return the associated {@code ReloadingController}
    037     */
    038    ReloadingController getReloadingController();
    039}