RequestProcessor
executor service. For task tracking purposes, use the
Progress API.
See usage examples to start working
with the new APIs.@Deprecated
public abstract class Task<T>
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected TaskState |
state
Deprecated.
|
protected TaskID |
taskID
Deprecated.
|
Constructor and Description |
---|
Task(java.lang.String implementorID,
int maxProgress)
Deprecated.
The constructor for a Task.
|
Task(java.lang.String implementorID,
java.lang.String userTaskID,
int maxProgress)
Deprecated.
The constructor for a Task.
|
Modifier and Type | Method and Description |
---|---|
void |
addTaskListener(TaskListener tl)
Deprecated.
Add a TaskListener to the this task.
|
TaskID |
getID()
Deprecated.
Retrieves the unique ID of the Task
|
java.util.ArrayList<TaskListener> |
getListenerList()
Deprecated.
Retrieve the listener list for this task
|
TaskEvent |
getNewTaskEvent()
Deprecated.
Get a new instance of TaskEvent.
|
abstract T |
getResult()
Deprecated.
If the task has produced aretrieveable result, this method will allow
retrieval.
|
java.lang.String |
getShortName()
Deprecated.
Retrieves the implementor ID (not guranteed to be unique) It is expected to
be meaningful to the implementor only.
|
TaskState |
getState()
Deprecated.
Retrieve the current state of the Task.
|
abstract int |
getTimeLeftSeconds()
Deprecated.
An estimate in seconds of the time left.
|
int |
getTotalCount()
Deprecated.
A task implementor must provide a quantitative measure of the Task.
|
abstract TaskExitCode |
performTask(TaskMonitor tc)
Deprecated.
This is the client method that will perform the actual work of this task.
|
void |
removeTaskListener(TaskListener tl)
Deprecated.
Remove a TaskListener from the this task.
|
public Task(java.lang.String implementorID, int maxProgress)
implementorID
- the client-chosen ID, no requirements from the Task API.maxProgress
- int count of the maximum progress 'count' for this
task. This is used for normalizing and firing taskUpdates for the
sub-tasks of this task. Must be equal or greater than 100.public Task(java.lang.String implementorID, java.lang.String userTaskID, int maxProgress) throws TaskException
implementorID
- the client-chosen ID, no requirements from the Task API.userTaskID
- the client-chosen ID, must be unique. Uniqueness to be assured
by the user.maxProgress
- int count of the maximum progress 'count' for this
task. This is used for normalizing and firing taskUpdates for the
sub-tasks of this task. Must be equal or greater than 100.TaskException
public java.util.ArrayList<TaskListener> getListenerList()
public final void addTaskListener(TaskListener tl)
tl
- TaskListener which will be added to this taskpublic final void removeTaskListener(TaskListener tl)
tl
- TaskListener that will be removed from this taskpublic TaskID getID()
public java.lang.String getShortName()
public int getTotalCount()
public abstract int getTimeLeftSeconds()
public TaskEvent getNewTaskEvent()
public TaskState getState()
public abstract T getResult()
public abstract TaskExitCode performTask(TaskMonitor tc) throws java.lang.Exception
tc
- TaskMonitor this is the access point for the Task itself to
access the services which are offered, for example providing
progress update or acquaring locks etc.java.lang.Exception