org.eclipse.soda.dk.epcglobal.llrp.helper.taskmanager
Class AbstractTask

java.lang.Object
  EscObject
      org.eclipse.soda.dk.epcglobal.llrp.helper.taskmanager.AbstractTask

All Implemented Interfaces:

ITask

Direct Known Subclasses:

AbstractLLRPTask, AbstractTask_ACCESS_TAG, Task_Array, Task_DELETE_EXIST_ACCESSSPEC, Task_DELETE_EXIST_ROSPEC, Task_INCREMENT_WRITE, Task_START_EXIST_ROSPEC, Task_STOP_EXIST_ROSPEC, TaskManager

public abstract class AbstractTask
extends EscObject
implements ITask

Since:

1.0

Version:

1.2.0

Field Summary

protected static java.util.Map	EMPTY_RESULT Define the empty result (Map) constant.
protected java.lang.Byte	listenerLock Define the listener lock (Byte) field.
protected java.lang.Byte	timerLock Define the timer lock (Byte) field.

Fields inherited from interface org.eclipse.soda.dk.epcglobal.llrp.helper.taskmanager.ITask

ABORT, ERROR, REPORT, STATE_RUNNING, STATE_STANDBY, SUCCESS, TIMEOUT

Constructor Summary

protected

AbstractTask() Constructs an instance of this class.

Method Summary

void	abort() Abort.
void	addTaskListener(ITaskListener listener) Add task listener with the specified listener parameter.
protected int	getState() Gets the state (int) value.
java.util.Set	getTaskListeners() Gets the task listeners (Set) value.
ITaskManager	getTaskManager() Gets the task manager (ITaskManager) value.
java.lang.Object	getTaskOwner() Gets the task owner (Object) value.
protected boolean	isRemoveListenerRequired() Gets the remove listener required (boolean) value.
boolean	isResponseExpected(SignalService source, java.lang.Object timestamp, java.lang.Object data) Is response expected with the specified source, timestamp and data parameters and return the boolean result.
void	notifyListener(java.lang.String taskName, int status, java.lang.Object result) Notify listener with the specified finished and result parameters.
protected void	preNotifyListener(java.lang.String taskName, int status, java.lang.Object result) Pre notify listener with the specified task name, status and result parameters.
void	removeTaskListener(ITaskListener listener) Remove task listener with the specified listener parameter.
protected void	removeTaskListenerNoThread(ITaskListener listener) Remove task listener no thread with the specified listener parameter.
void	reset() Reset.
protected void	setState(int state) Sets the state value.
void	setTaskListeners(java.util.Set taskListeners) Sets the task listeners value.
void	setTaskManager(ITaskManager taskManager) Sets the task manager value.
void	setTaskOwner(java.lang.Object taskOwner) Sets the task owner value.
void	start() Start.
void	start(ITaskManager taskManager) Start with the specified task manager parameter.
protected void	startTimer(long millis) Start timer with the specified millis parameter.
protected void	stopTimer() Stop timer.
protected void	timeOutOccurred() Time out occurred.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.soda.dk.epcglobal.llrp.helper.taskmanager.ITask

duplicateTask, getTaskName, handleResponse, launchTask

Field Detail

EMPTY_RESULT

protected static final java.util.Map EMPTY_RESULT

Define the empty result (Map) constant.

listenerLock

protected java.lang.Byte listenerLock

Define the listener lock (Byte) field.

timerLock

protected java.lang.Byte timerLock

Define the timer lock (Byte) field.

Constructor Detail

AbstractTask

protected AbstractTask()

Constructs an instance of this class.

Method Detail

addTaskListener

public void addTaskListener(ITaskListener listener)

Add task listener with the specified listener parameter.

Specified by:

addTaskListener in interface ITask

Parameters:

listener - The listener (ITaskListener) parameter.

See Also:

ITask.removeTaskListener(ITaskListener)

getState

protected int getState()

Gets the state (int) value.

Returns:

The state (int) value.

See Also:

#getTimerState(), #setTimerState(int)

getTaskListeners

public java.util.Set getTaskListeners()

Gets the task listeners (Set) value.

Returns:

The task listeners (List) value.

isRemoveListenerRequired

protected boolean isRemoveListenerRequired()

Gets the remove listener required (boolean) value.

Returns:

The remove listener required (boolean) value.

notifyListener

public void notifyListener(java.lang.String taskName,
                           int status,
                           java.lang.Object result)

Notify listener with the specified finished and result parameters.

Specified by:

notifyListener in interface ITask

Parameters:

taskName - The task name (String) parameter.

status - The status (int) parameter.

result - The result (Object) parameter.

See Also:

ITask.addTaskListener(ITaskListener), ITask.removeTaskListener(ITaskListener)

preNotifyListener

protected void preNotifyListener(java.lang.String taskName,
                                 int status,
                                 java.lang.Object result)

Pre notify listener with the specified task name, status and result parameters.

Parameters:

taskName - The task name (String) parameter.

status - The status (int) parameter.

result - The result (Object) parameter.

abort

public void abort()

Abort.

Specified by:

abort in interface ITask

getTaskManager

public ITaskManager getTaskManager()

Gets the task manager (ITaskManager) value.

Specified by:

getTaskManager in interface ITask

Returns:

The task manager (ITaskManager) value.

See Also:

ITask.setTaskManager(ITaskManager)

getTaskOwner

public java.lang.Object getTaskOwner()

Gets the task owner (Object) value.

Specified by:

getTaskOwner in interface ITask

Returns:

The task owner (Object) value.

See Also:

ITask.setTaskOwner(Object)

isResponseExpected

public boolean isResponseExpected(SignalService source,
                                  java.lang.Object timestamp,
                                  java.lang.Object data)

Is response expected with the specified source, timestamp and data parameters and return the boolean result.

Specified by:

isResponseExpected in interface ITask

Parameters:

source - The source (SignalService) parameter.

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

Returns:

Results of the is response expected (boolean) value.

removeTaskListener

public void removeTaskListener(ITaskListener listener)

Remove task listener with the specified listener parameter.

Specified by:

removeTaskListener in interface ITask

Parameters:

listener - The listener (ITaskListener) parameter.

See Also:

ITask.addTaskListener(ITaskListener)

removeTaskListenerNoThread

protected void removeTaskListenerNoThread(ITaskListener listener)

Remove task listener no thread with the specified listener parameter.

Parameters:

listener - The listener (ITaskListener) parameter.

reset

public void reset()

Reset.

Specified by:

reset in interface ITask

setState

protected void setState(int state)

Sets the state value.

Parameters:

state - The state (int) parameter.

setTaskListeners

public void setTaskListeners(java.util.Set taskListeners)

Sets the task listeners value.

Parameters:

taskListeners - The task listeners (List) parameter.

setTaskManager

public void setTaskManager(ITaskManager taskManager)

Sets the task manager value.

Specified by:

setTaskManager in interface ITask

Parameters:

taskManager - The task manager (ITaskManager) parameter.

See Also:

ITask.getTaskManager()

setTaskOwner

public void setTaskOwner(java.lang.Object taskOwner)

Sets the task owner value.

Specified by:

setTaskOwner in interface ITask

Parameters:

taskOwner - The task owner (Object) parameter.

See Also:

ITask.getTaskOwner()

start

public void start()

Start.

Specified by:

start in interface ITask

See Also:

ITask.start(ITaskManager)

start

public void start(ITaskManager taskManager)

Start with the specified task manager parameter.

Specified by:

start in interface ITask

Parameters:

taskManager - The task manager (ITaskManager) parameter.

See Also:

ITask.start()

startTimer

protected void startTimer(long millis)

Start timer with the specified millis parameter.

Parameters:

millis - The millis (long) parameter.

stopTimer

protected void stopTimer()

Stop timer.

timeOutOccurred

protected void timeOutOccurred()

Time out occurred.