Interface PeriodicJob
-
public interface PeriodicJob
- Since:
- 5.3
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
cancel()
Cancels the job.String
getName()
Returns the name for the job, supplied when the job is created; this is not unique or meaningful, and primarily exists to assist with debugging.boolean
isCanceled()
Has this job been canceled.boolean
isExecuting()
Is this Job currently executing (or queued, awaiting execution)?
-
-
-
Method Detail
-
getName
String getName()
Returns the name for the job, supplied when the job is created; this is not unique or meaningful, and primarily exists to assist with debugging.- Returns:
- name provided for the job
-
isExecuting
boolean isExecuting()
Is this Job currently executing (or queued, awaiting execution)?- Returns:
- true if executing
-
isCanceled
boolean isCanceled()
Has this job been canceled.
-
cancel
void cancel()
Cancels the job. If currently executing, the Job will finish (this includes awaiting execution). If not currently executing, the job is discarded immediately.
-
-