org.cattleframework.quartz.annotation.QuartzJob Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cattle-quartz Show documentation

Cattle framework quartz component pom

The newest version!

/*
 * Copyright (C) 2018 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 org.cattleframework.quartz.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.cattleframework.quartz.TriggerType;

/**
 * 定时器作业
 * 
 * @author orange
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface QuartzJob {

    /**
     * 定时器名称
     * 
     * @return 定时器名称
     */
    String name() default "";

    /**
     * 定时器描述
     * 
     * @return 定时器描述
     */
    String description() default "";

    /**
     * 触发器类型
     * 
     * @return 触发器类型
     */
    TriggerType type();

    /**
     * 间隔值
     * 
     * @return 间隔值
     */
    int interval() default 0;

    /**
     * 是否立即执行
     * 
     * @return 是否立即执行
     */
    boolean immediately() default false;

    /**
     * Profile值
     * 
     * @return Profile值
     */
    String[] profile() default {};

    /**
     * 是否有效的属性名
     * 
     * @return 是否有效的属性名
     */
    String enabledProperty() default "";

    /**
     * 是否有效的属性匹配缺省值
     * 
     * @return 是否有效的属性匹配缺省值
     */
    boolean enabledMatchIfMissing() default true;

    /**
     * 匹配的条件值
     * 
     * @return 匹配的条件值
     */
    boolean matchConditionalValue() default true;
}