ai.preferred.venom.job

Class FutureJobWrapper

java.lang.Object

ai.preferred.venom.job.FutureJobWrapper

All Implemented Interfaces:

FutureJob<Request>, Job, Comparable<Job>, Future<Request>

public class FutureJobWrapper
extends Object
implements FutureJob<Request>

Constructor Summary

Constructors

Constructor and Description
FutureJobWrapper(Job job)

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning) Attempts to cancel execution of this task.
int	compareTo(Job o)
void	done() Set done to true and interrupts all the threads
Request	get()
Request	get(long timeout, TimeUnit unit)
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.
void	set(Request result) Sets the result of this future to the given value unless this future has already been set or has been cancelled.

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureJobWrapper

public FutureJobWrapper(Job job)

Method Detail

getRequest

public 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 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 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 void reQueue()

Description copied from interface: FutureJob

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

Does nothing if isDone() == true or isCancelled() == true or getThreadCount > 0

Specified by:

reQueue in interface FutureJob<Request>

Specified by:

reQueue in interface Job

getTryCount

public 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.

cancel

public 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

Specified by:

cancel in interface Future<Request>

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 boolean isCancelled()

Description copied from interface: Job

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

Specified by:

isCancelled in interface Job

Specified by:

isCancelled in interface Future<Request>

Returns:

true if this task was cancelled before it completed

isDone

public 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

Specified by:

isDone in interface Future<Request>

Returns:

true if this task completed

done

public void done()

Description copied from interface: Job

Set done to true and interrupts all the threads

Specified by:

done in interface Job

compareTo

public int compareTo(@Nonnull
                     Job o)

Specified by:

compareTo in interface Comparable<Job>

set

public void set(Request result)

Description copied from interface: FutureJob

Sets the result of this future to the given value unless this future has already been set or has been cancelled.

Specified by:

set in interface FutureJob<Request>

Parameters:

result - the result value

get

public Request get()

Specified by:

get in interface Future<Request>

get

public Request get(long timeout,
                   @Nonnull
                   TimeUnit unit)

Specified by:

get in interface Future<Request>