Package org.jppf.client.taskwrapper

Class JPPFAnnotatedTask

java.lang.Object

org.jppf.node.protocol.AbstractTask<Object>

org.jppf.client.taskwrapper.JPPFAnnotatedTask

All Implemented Interfaces:

Serializable, Runnable, CancellationHandler, Interruptibility, PositionalElement<Task<Object>>, Task<Object>

public class JPPFAnnotatedTask
extends AbstractTask<Object>
implements CancellationHandler

JPPF task wrapper for an object whose class is annotated with JPPFRunnable.

Author:

Laurent Cohen

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JPPFTaskCallback<Object>	cancelCallback	A delegate for the onCancel() method.
protected TaskObjectWrapper	taskObjectWrapper	Wrapper around a task that is not an instance of Task.
protected JPPFTaskCallback<Object>	timeoutCallback	A delegate for the onTimeout() method.

Constructor Summary

Constructors

Constructor	Description
JPPFAnnotatedTask(Object taskObject, Object... args)	Initialize this task with an object whose class is either annotated with JPPFRunnable, an instance of Runnable or an instance of Callable.
JPPFAnnotatedTask(Object taskObject, String method, Object... args)	Initialize this task from a POJO, given a method and its arguments to execute it.

Method Summary

Modifier and Type	Method	Description
void	doCancelAction()	Invoked immediately when a task is cancelled.
Object	getTaskObject()	Get the JPPFRunnable-annotated object or POJO wrapped by this task.
boolean	isInterruptible()	Determine whether the thread executing the task can be interrupted.
void	onCancel()	Callback invoked when this task is cancelled.
void	onTimeout()	Callback invoked when this task times out.
void	run()	Run the JPPFRunnable-annotated method of the task object.
JPPFAnnotatedTask	setCancelCallback(JPPFTaskCallback<Object> cancelCallback)	Set the delegate for the onCancel() method.
JPPFAnnotatedTask	setDataProvider(DataProvider dataProvider)	Override of Task.setDataProvider(DataProvider) to enable setting the data provider onto tasks that are not subclasses of Task and which implement DataProviderHolder.
JPPFAnnotatedTask	setTimeoutCallback(JPPFTaskCallback<Object> timeoutCallback)	Set the delegate for the onTimeout() method.

Methods inherited from class org.jppf.node.protocol.AbstractTask

compute, fireNotification, getDataProvider, getId, getJob, getMaxResubmits, getNode, getPosition, getResult, getTaskClassLoader, getThrowable, getTimeoutSchedule, isInNode, isResubmit, setExecutionDispatcher, setId, setInNode, setJob, setMaxResubmits, setNode, setPosition, setResubmit, setResult, setThrowable, setTimeoutSchedule

Methods inherited from class java.lang.Object

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

Field Details

taskObjectWrapper

protected TaskObjectWrapper taskObjectWrapper

Wrapper around a task that is not an instance of Task.

cancelCallback

protected JPPFTaskCallback<Object> cancelCallback

A delegate for the onCancel() method.

timeoutCallback

protected JPPFTaskCallback<Object> timeoutCallback

A delegate for the onTimeout() method.

Constructor Details

JPPFAnnotatedTask

public JPPFAnnotatedTask(Object taskObject,
 Object... args)
                  throws JPPFException

Initialize this task with an object whose class is either annotated with JPPFRunnable, an instance of Runnable or an instance of Callable.

Parameters:

taskObject - an object that encapsulates the task to execute.

args - the optional arguments for a class that has one of its methods annotated with JPPFRunnable.

Throws:

JPPFException - if an error is raised while initializing this task.

JPPFAnnotatedTask

public JPPFAnnotatedTask(Object taskObject,
 String method,
 Object... args)
                  throws JPPFException

Initialize this task from a POJO, given a method and its arguments to execute it.

Parameters:

taskObject - either an instance of the POJO class if the method is non-static, or a class object if the method is static.

method - the name of the method to execute.

args - the arguments for the method to execute.

Throws:

JPPFException - if an error is raised while initializing this task.

Method Details

run

public void run()

Run the JPPFRunnable-annotated method of the task object.

Specified by:

run in interface Runnable

Overrides:

run in class AbstractTask<Object>

getTaskObject

public Object getTaskObject()

Get the JPPFRunnable-annotated object or POJO wrapped by this task.

Specified by:

getTaskObject in interface Task<Object>

Overrides:

getTaskObject in class AbstractTask<Object>

Returns:

an object or class that is JPPF-annotated.

setCancelCallback

public JPPFAnnotatedTask setCancelCallback(JPPFTaskCallback<Object> cancelCallback)

Set the delegate for the onCancel() method.

Parameters:

cancelCallback - a JPPFTaskCallback instance.

Returns:

this task, for method chaining.

setTimeoutCallback

public JPPFAnnotatedTask setTimeoutCallback(JPPFTaskCallback<Object> timeoutCallback)

Set the delegate for the onTimeout() method.

Parameters:

timeoutCallback - a JPPFTaskCallback instance.

Returns:

this task, for method chaining.

onCancel

public void onCancel()

Description copied from interface: Task

Callback invoked when this task is cancelled. The default implementation does nothing and should be overriden by subclasses that desire to implement a specific behaviour on cancellation.

Specified by:

onCancel in interface Task<Object>

Overrides:

onCancel in class AbstractTask<Object>

onTimeout

public void onTimeout()

Description copied from interface: Task

Callback invoked when this task times out. The default implementation does nothing and should be overriden by subclasses that desire to implement a specific behaviour on timeout.

Specified by:

onTimeout in interface Task<Object>

Overrides:

onTimeout in class AbstractTask<Object>

setDataProvider

public JPPFAnnotatedTask setDataProvider(DataProvider dataProvider)

Override of Task.setDataProvider(DataProvider) to enable setting the data provider onto tasks that are not subclasses of Task and which implement DataProviderHolder.

Specified by:

setDataProvider in interface Task<Object>

Overrides:

setDataProvider in class AbstractTask<Object>

Parameters:

dataProvider - the data provider to set onto the task.

Returns:

this task, for method chaining.

isInterruptible

public boolean isInterruptible()

Description copied from interface: Interruptibility

Determine whether the thread executing the task can be interrupted.

Specified by:

isInterruptible in interface Interruptibility

Overrides:

isInterruptible in class AbstractTask<Object>

Returns:

true if the task can be interrupted, false otherwise.

doCancelAction

public void doCancelAction()
                    throws Exception

Description copied from interface: CancellationHandler

Invoked immediately when a task is cancelled.

Specified by:

doCancelAction in interface CancellationHandler

Throws:

Exception - if any error occurs while this callback is executing.