ai.preferred.venom.job

Interface Job

All Superinterfaces:

Comparable<Job>

All Known Implementing Classes:

BasicJob

public interface Job
extends Comparable<Job>

This interface represents only the most basic of a job, to be placed in a scheduler or other forms.

Author:

Maksim Tkachenko, Ween Jiann Lee

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning) Attempts to cancel execution of this task.
void	done() Set done to true and interrupts all the threads.
Handleable	getHandler() Get the handler to handle the response of the job.
Priority	getPriority() Get the current priority set for this job.
@NotNull Request	getRequest() Get the request of this job.
int	getTryCount() Get attempt number of this job.
boolean	isCancelled() Returns true if this task was cancelled before it completed normally.
boolean	isDone() Returns true if this task completed.
void	reQueue() Remove any existing in queue, downgrades the priority and adds the job back into queue.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getRequest

@NotNull
@NotNull Request getRequest()

Get the request of this job.

Returns:

Request of the job.

getHandler

@Nullable
Handleable getHandler()

Get the handler to handle the response of the job.

If handler is null, routed handler will be used to assign a handler to the response, based on its criteria.

Returns:

Handler for the response or null.

getPriority

Priority getPriority()

Get the current priority set for this job.

Returns:

the current priority of the job.

reQueue

void reQueue()

Remove any existing in queue, downgrades the priority and adds the job back into queue.

getTryCount

int getTryCount()

Get attempt number of this job.

Returns:

Attempt (try) count of the job.

cancel

boolean cancel(boolean mayInterruptIfRunning)

Attempts to cancel execution of this task. This attempt will fail if the task has already completed, has already been cancelled, or could not be cancelled for some other reason. If successful, and this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.

After this method returns, subsequent calls to isCancelled() will always return true if this method returned true.

Parameters:

mayInterruptIfRunning - true if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete

Returns:

false if the task could not be cancelled, typically because it has already completed normally; true otherwise

isCancelled

boolean isCancelled()

Returns true if this task was cancelled before it completed normally.

Returns:

true if this task was cancelled before it completed

isDone

boolean isDone()

Returns true if this task completed.

Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Returns:

true if this task completed

done

void done()

Set done to true and interrupts all the threads.