org.jppf.client.taskwrapper

Class JPPFAnnotatedTask

java.lang.Object

org.jppf.server.protocol.JPPFTask

org.jppf.client.taskwrapper.JPPFAnnotatedTask

All Implemented Interfaces:

Serializable, Runnable, Task<Object>

public class JPPFAnnotatedTask
extends JPPFTask

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

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and 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

Methods

Modifier and Type	Method and Description
Object	getTaskObject() Get the JPPFRunnable-annotated object or POJO wrapped by this task.
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.
void	setCancelCallback(JPPFTaskCallback cancelCallback) Set the delegate for the onCancel() method.
void	setDataProvider(DataProvider dataProvider) Override of JPPFTask.setDataProvider(DataProvider) to enable setting the data provider onto tasks that are not subclasses of JPPFTask and which implement DataProviderHolder.
void	setTimeoutCallback(JPPFTaskCallback timeoutCallback) Set the delegate for the onTimeout() method.

Methods inherited from class org.jppf.server.protocol.JPPFTask

compute, getDataProvider, getException, getId, getPosition, getResult, getTimeoutSchedule, isInNode, setException, setId, setPosition, setResult, setTimeoutSchedule

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jppf.node.protocol.Task

onRestart

Field Detail

taskObjectWrapper

protected TaskObjectWrapper taskObjectWrapper

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

cancelCallback

protected JPPFTaskCallback cancelCallback

A delegate for the onCancel() method.

timeoutCallback

protected JPPFTaskCallback timeoutCallback

A delegate for the onTimeout() method.

Constructor Detail

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 Detail

run

public void run()

Run the JPPFRunnable-annotated method of the task object.

See Also:

Runnable.run()

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 JPPFTask

Returns:

an object or class that is JPPF-annotated.

See Also:

JPPFTask.getTaskObject()

setCancelCallback

public void setCancelCallback(JPPFTaskCallback cancelCallback)

Set the delegate for the onCancel() method.

Parameters:

cancelCallback - a JPPFTaskCallback instance.

setTimeoutCallback

public void setTimeoutCallback(JPPFTaskCallback timeoutCallback)

Set the delegate for the onTimeout() method.

Parameters:

timeoutCallback - a JPPFTaskCallback instance.

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 JPPFTask

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 JPPFTask

setDataProvider

public void setDataProvider(DataProvider dataProvider)

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

Specified by:

setDataProvider in interface Task<Object>

Overrides:

setDataProvider in class JPPFTask

Parameters:

dataProvider - the data provider to set onto the task.