oracle.ide.task

Class CancellableTask

java.lang.Object

oracle.ide.task.Task

oracle.ide.task.CancellableTask

Deprecated.

For asynchronous tasks running, use the 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 CancellableTask
extends Task

A cancellable task extends a Task with the additional method for requesting cancellation.

Field Summary

Fields inherited from class oracle.ide.task.Task

state, taskID

Constructor Summary

Constructors

Constructor and Description
CancellableTask(java.lang.String shortName, int maxProgress) Deprecated. Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	requestCancellation() Deprecated. Request this task to Cancel itself.

Methods inherited from class oracle.ide.task.Task

addTaskListener, getID, getListenerList, getNewTaskEvent, getResult, getShortName, getState, getTimeLeftSeconds, getTotalCount, performTask, removeTaskListener

Methods inherited from class java.lang.Object

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

Constructor Detail

CancellableTask

public CancellableTask(java.lang.String shortName,
               int maxProgress)
                throws TaskException

Deprecated.

Constructor

Parameters:

shortName - name usually displayed in UIs

maxProgress - int the Maximum progress count for this task

Throws:

TaskException - if any parameters are not valid

Method Detail

requestCancellation

public void requestCancellation()

Deprecated.

Request this task to Cancel itself. This changes the internal state of the task to CANCEL_REQUESTED but does not necessarily terminate the task. It is upto the implementor to check this state variable and terminate the task.