001/*
002 * Copyright 2002-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.scheduling.config;
018
019/**
020 * {@link Task} implementation defining a {@code Runnable} to be executed at a given
021 * millisecond interval which may be treated as fixed-rate or fixed-delay depending on
022 * context.
023 *
024 * @author Chris Beams
025 * @since 3.2
026 * @see ScheduledTaskRegistrar#addFixedRateTask(IntervalTask)
027 * @see ScheduledTaskRegistrar#addFixedDelayTask(IntervalTask)
028 */
029public class IntervalTask extends Task {
030
031        private final long interval;
032
033        private final long initialDelay;
034
035
036        /**
037         * Create a new {@code IntervalTask}.
038         * @param runnable the underlying task to execute
039         * @param interval how often in milliseconds the task should be executed
040         * @param initialDelay the initial delay before first execution of the task
041         */
042        public IntervalTask(Runnable runnable, long interval, long initialDelay) {
043                super(runnable);
044                this.interval = interval;
045                this.initialDelay = initialDelay;
046        }
047
048        /**
049         * Create a new {@code IntervalTask} with no initial delay.
050         * @param runnable the underlying task to execute
051         * @param interval how often in milliseconds the task should be executed
052         */
053        public IntervalTask(Runnable runnable, long interval) {
054                this(runnable, interval, 0);
055        }
056
057
058        /**
059         * Return how often in milliseconds the task should be executed.
060         */
061        public long getInterval() {
062                return this.interval;
063        }
064
065        /**
066         * Return the initial delay before first execution of the task.
067         */
068        public long getInitialDelay() {
069                return this.initialDelay;
070        }
071
072}