ninja.scheduler.Schedule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ninja-core Show documentation
There is a newer version: 7.0.0
/**
 * Copyright (C) the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ninja.scheduler;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.concurrent.TimeUnit;

/**
 * Schedules the annotated method for execution
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Schedule {

    /**
     * The delay between executions. Is used as the default if no delay property is found.
     *
     * @return The delay between executions
     */
    long delay() default -1;

    /**
     * The property to read the delay from.  If not specified, delay is used.
     *
     * @return The name of the property to read the delay from.
     */
    String delayProperty() default NO_PROPERTY;

    /**
     * The time unit, defaults to milliseconds
     *
     * @return The time unit
     */
    TimeUnit timeUnit() default TimeUnit.MILLISECONDS;

    /**
     * The property to read the time unit from.  If not specified, timeUnit is used.
     *
     * @return The property to read the time unit from.
     */
    String timeUnitProperty() default NO_PROPERTY;

    /**
     * The delay before it should first be run.  If negative, the delay is used as the initial delay.
     *
     * @return The delay
     */
    long initialDelay() default -1;

    /**
     * The property to read the initial delay from.  If not specified, initialDelay is used.
     *
     * @return The property to read the initial delay from.
     */
    String initialDelayProperty() default NO_PROPERTY;

    /**
     * A CRON-like expression containing the second, minute, hour, day of month, month, and day of week.
     *
     * @return The CRON expression
     */
    String cron() default NO_PROPERTY;

    /**
     * A time zone for which the CRON expression will be resolved. If not specified, the server's local time
     * zone will be used.
     *
     * @return A zone id accepted by {@code TimeZone.getTimeZone(String)}
     */
    String cronZone() default NO_PROPERTY;

    String NO_PROPERTY = "_no-property";
}