|
Gephi Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gephi.utils.longtask.api.LongTaskExecutor
public final class LongTaskExecutor
Portable long-task executor, that supports synchronous and asynchronous execution, progress, cancellation and error management.
Note that only one task can be executed by the executor at one time.
LongTask
Constructor Summary | |
---|---|
LongTaskExecutor(boolean doInBackground)
Creates a new long task executor. |
|
LongTaskExecutor(boolean doInBackground,
java.lang.String name)
Creates a new long task executor. |
|
LongTaskExecutor(boolean doInBackground,
java.lang.String name,
int interruptDelay)
Creates a new long task executor. |
Method Summary | |
---|---|
void |
cancel()
Cancel the current task. |
void |
execute(LongTask task,
java.lang.Runnable runnable)
Execute a long task with cancel and progress support. |
void |
execute(LongTask task,
java.lang.Runnable runnable,
java.lang.String taskName,
LongTaskErrorHandler errorHandler)
Execute a long task with cancel and progress support. |
boolean |
isRunning()
Returns true if the executor is executing a task. |
void |
setDefaultErrorHandler(LongTaskErrorHandler errorHandler)
Set the default error handler. |
void |
setLongTaskListener(LongTaskListener listener)
Set the listener to this executor. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LongTaskExecutor(boolean doInBackground, java.lang.String name, int interruptDelay)
doInBackground
- when true
, the task will be executed in a separate threadname
- the name of the executor, used to recognize threads by namesinterruptDelay
- number of seconds to wait before calling Thread.interrupt()
after a cancel requestpublic LongTaskExecutor(boolean doInBackground, java.lang.String name)
doInBackground
- doInBackground when true
, the task will be executed in a separate threadname
- the name of the executor, used to recognize threads by namespublic LongTaskExecutor(boolean doInBackground)
doInBackground
- doInBackground when true
, the task will be executed in a separate threadMethod Detail |
---|
public void execute(LongTask task, java.lang.Runnable runnable, java.lang.String taskName, LongTaskErrorHandler errorHandler)
null
.
In this case runnable
will be executed normally, but without
cancel and progress support.
task
- the task to be executed, can be null
.runnable
- the runnable to be executedtaskName
- the name of the task, is displayed in the status bar if availableerrorHandler
- error handler for exception retrieval during execution
java.lang.NullPointerException
- if runnable
or taskName
is null
java.lang.IllegalStateException
- if a task is still executing at this timepublic void execute(LongTask task, java.lang.Runnable runnable)
null
.
In this case runnable
will be executed normally, but without
cancel and progress support.
task
- the task to be executed, can be null
.runnable
- the runnable to be executed
java.lang.NullPointerException
- if runnable
is null
java.lang.IllegalStateException
- if a task is still executing at this timepublic void cancel()
interruptDelay
has been specified,
the task will be interrupted after interruptDelay
. Using Thread.interrupt()
may cause
hazardous behaviours and should be avoided. Therefore any task should be cancellable.
public boolean isRunning()
true
if the executor is executing a task.
true
if a task is running, false
otherwisepublic void setLongTaskListener(LongTaskListener listener)
listener
- a listener for this executorpublic void setDefaultErrorHandler(LongTaskErrorHandler errorHandler)
errorHandler
- the default error handler
|
Gephi Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |