oracle.jdeveloper.usage.util

Class TaskMultiplexer.TaskWrapper

java.lang.Object

oracle.javatools.parser.util.AsyncTask

oracle.jdeveloper.usage.util.AbstractBackgroundTask

oracle.jdeveloper.usage.util.TaskMultiplexer.TaskWrapper

All Implemented Interfaces:

java.lang.Runnable, BackgroundTask

Enclosing class:

TaskMultiplexer

public abstract static class TaskMultiplexer.TaskWrapper
extends AbstractBackgroundTask

Our wrapper for a FileListQueryTask.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.parser.util.AsyncTask

AsyncTask.CancelledException

Field Summary

Fields inherited from class oracle.javatools.parser.util.AsyncTask

CANCELLED_RESULT, STATUS_CANCELLED, STATUS_COMPLETED, STATUS_FAILED, STATUS_READY, STATUS_RUNNING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TaskMultiplexer.TaskWrapper(TaskMultiplexer multiplexer) Construct a new task wrapper.

Method Summary

Methods

Modifier and Type	Method and Description
protected AsyncScheduler	getSchedulerImpl() Requests the scheduler that this task was scheduled with.
protected abstract BackgroundTask	getSharedBackgroundTask() Implementation-dependent routine for fetching the shared background task that this request (and others) would multiplex on.
protected void	initializeComplete() Subclasses should call this after their constructor completes to actually start the wrapper.
protected java.lang.Object	runTaskImpl() Implementation of this task.
protected abstract void	saveResults(BackgroundTask task) Implementation-dependent routine to save the results of the background task.

Methods inherited from class oracle.jdeveloper.usage.util.AbstractBackgroundTask

cancel, cancelTaskImpl, getProgress, getProgressText, isCancelledImpl, requestCancelImpl, runImpl, setProgress, setProgressFromSubTask, setProgressFromSubTask, setProgressText

Methods inherited from class oracle.javatools.parser.util.AsyncTask

bailIfCancelled, getResult, getStatus, isFinished, requestCancel, run, sleep, waitUntilFinished, waitUntilFinished

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jdeveloper.usage.util.BackgroundTask

isFinished, waitUntilFinished

Constructor Detail

TaskMultiplexer.TaskWrapper

protected TaskMultiplexer.TaskWrapper(TaskMultiplexer multiplexer)

Construct a new task wrapper. This will automatically schedule the wrapper for execution.

Parameters:

table - the file table to get a query task from

Method Detail

initializeComplete

protected void initializeComplete()

Subclasses should call this after their constructor completes to actually start the wrapper. This has to be done after, otherwise anything that the subclass depends on to be initialized may not have completed before it is needed in runImpl().

getSchedulerImpl

protected final AsyncScheduler getSchedulerImpl()

Requests the scheduler that this task was scheduled with. This is up to the implementation to fill in with the scheduler it uses for tasks. This will only be used for the purposes of cancelling the task. If your task is cancellable, you should return the scheduler here.

Specified by:

getSchedulerImpl in class AbstractBackgroundTask

Returns:

the scheduler of this task, or null if the task is not cancellable

getSharedBackgroundTask

protected abstract BackgroundTask getSharedBackgroundTask()

Implementation-dependent routine for fetching the shared background task that this request (and others) would multiplex on.

Returns:

the shared background task

saveResults

protected abstract void saveResults(BackgroundTask task)

Implementation-dependent routine to save the results of the background task. This will be called when the background task has completed successfully.

Parameters:

task - the background task that completed

runTaskImpl

protected java.lang.Object runTaskImpl()
                                throws AsyncTask.CancelledException

Implementation of this task. Subclasses should override this.

Specified by:

runTaskImpl in class AbstractBackgroundTask

Returns:

the implementation-specific return result (if any), or CANCELLED_RESULT if the operation is cancelled

Throws:

CancelledException - if the task has been cancelled

AsyncTask.CancelledException