package act.job;
/*-
* #%L
* ACT Framework
* %%
* Copyright (C) 2014 - 2017 ActFramework
* %%
* 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.
* #L%
*/
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Mark a method to be a job that must be run before App stop
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface OnAppStop {
/**
* <p>Indicate if the job should be run synchronously with application
* or asynchronously.</p>
* <p>Running job synchronously means other jobs can be executed with other jobs
* in parallel</p>
* <p>Running job asynchronously means the job block the application stop process
* until it finished</p>
* @return {@code true} if the annotated method shall be executed asynchronously
* or {@code false} if the method all be executed synchronously
*/
boolean async() default false;
/**
* Specify the ID of the scheduled job. Default value: empty string
* @return the job id
*/
String id() default "";
}