RefreshInterval.java

/* 
 * The MIT License
 *
 * Copyright 2013 Tim Boudreau.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.mastfrog.settings;

import java.util.TimerTask;

/**
 * Defines a refresh interval.  Mutable for use with JMX.
 *
 * @author Tim Boudreau
 */
public interface RefreshInterval {
    public int getMilliseconds();
    public void setMilliseconds(int millis);
    public String name();
    public void add(TimerTask r);

    public static RefreshInterval NONE = new RefreshInterval() {

        @Override
        public int getMilliseconds() {
            return 0;
        }

        @Override
        public void setMilliseconds(int millis) {
            // do nothing
        }

        @Override
        public String name() {
            return "none";
        }

        @Override
        public void add(TimerTask r) {
            //do nothing
        }
    };
}