ai.preferred.venom.job

Class BasicJob

java.lang.Object

ai.preferred.venom.job.BasicJob

All Implemented Interfaces:

Job, Comparable<Job>

public class BasicJob
extends Object
implements Job

Author:

Ween Jiann Lee

Constructor Summary

Constructors

Constructor and Description
BasicJob(Request request, Handleable handler, Priority priority, Priority priorityFloor, Queue<Job> queue) Constructs a basic job.

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning) Attempts to cancel execution of this task.
int	compareTo(Job job)
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.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicJob

public BasicJob(Request request,
                Handleable handler,
                Priority priority,
                Priority priorityFloor,
                Queue<Job> queue)

Constructs a basic job.

Parameters:

request - The request of this job.

handler - The handler of this job.

priority - The priority of this job.

priorityFloor - The priority floor of this job.

queue - The queue for this job.

Method Detail

getRequest

public final Request getRequest()

Description copied from interface: Job

Get the request of this job.

Specified by:

getRequest in interface Job

Returns:

Request of the job.

getHandler

public final Handleable getHandler()

Description copied from interface: Job

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.

Specified by:

getHandler in interface Job

Returns:

Handler for the response or null.

getPriority

public final Priority getPriority()

Description copied from interface: Job

Get the current priority set for this job.

Specified by:

getPriority in interface Job

Returns:

the current priority of the job.

reQueue

public final void reQueue()

Description copied from interface: Job

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

Specified by:

reQueue in interface Job

getTryCount

public final int getTryCount()

Description copied from interface: Job

Get attempt number of this job.

Specified by:

getTryCount in interface Job

Returns:

Attempt (try) count of the job.

compareTo

public final int compareTo(@Nonnull
                           Job job)

Specified by:

compareTo in interface Comparable<Job>

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Description copied from interface: Job

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 Job.isCancelled() will always return true if this method returned true.

Specified by:

cancel in interface Job

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

public final boolean isCancelled()

Description copied from interface: Job

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

Specified by:

isCancelled in interface Job

Returns:

true if this task was cancelled before it completed

isDone

public final boolean isDone()

Description copied from interface: Job

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.

Specified by:

isDone in interface Job

Returns:

true if this task completed

done

public final void done()

Description copied from interface: Job

Set done to true and interrupts all the threads.

Specified by:

done in interface Job