com.sun.pdfview
Class BaseWatchable
public abstract
class
BaseWatchable
extends Object
implements Watchable, Runnable
An abstract implementation of the watchable interface, that is extended
by the parser and renderer to do their thing.
Method Summary |
protected void | cleanup()
Clean up after a set of iterations. |
protected void | execute(boolean synchronous)
Start executing this watchable
|
int | getStatus()
Get the status of this watchable
|
void | go()
Start this watchable and run in a new thread until it is finished or
stopped.
|
void | go(boolean synchronous)
Start this watchable and run until it is finished or stopped.
|
void | go(int steps)
Start this watchable and run for the given number of steps or until
finished or stopped.
|
void | go(long millis)
Start this watchable and run for the given amount of time, or until
finished or stopped.
|
boolean | isExecutable()
return true if this watchable is ready to be executed |
boolean | isFinished()
Return whether this watchable has finished. |
protected abstract int | iterate()
Perform a single iteration of this watchable. |
void | run() |
protected void | setError(Exception error)
Set an error on this watchable |
protected void | setStatus(int status)
Set the status of this watchable |
protected void | setup()
Prepare for a set of iterations. |
void | stop()
Stop this watchable. |
void | waitForFinish()
Wait for this watchable to finish |
protected BaseWatchable()
Creates a new instance of BaseWatchable
protected void cleanup()
Clean up after a set of iterations. Called after iteration has stopped
due to completion, manual stopping, or error.
protected void execute(boolean synchronous)
Start executing this watchable
Parameters: synchronous if true, run in this thread
public int getStatus()
Get the status of this watchable
Returns: one of the well-known statuses
public void go()
Start this watchable and run in a new thread until it is finished or
stopped.
Note the watchable may be stopped if go() with a
different time is called during execution.
public void go(boolean synchronous)
Start this watchable and run until it is finished or stopped.
Note the watchable may be stopped if go() with a
different time is called during execution.
Parameters: synchronous if true, run in this thread
public void go(int steps)
Start this watchable and run for the given number of steps or until
finished or stopped.
Parameters: steps the number of steps to run for
public void go(long millis)
Start this watchable and run for the given amount of time, or until
finished or stopped.
Parameters: millis the number of milliseconds to run for
public boolean isExecutable()
return true if this watchable is ready to be executed
public boolean isFinished()
Return whether this watchable has finished. A watchable is finished
when its status is either COMPLETED, STOPPED or ERROR
protected abstract int iterate()
Perform a single iteration of this watchable. This is the minimum
granularity which the go() commands operate over.
Returns: one of three values:
- Watchable.RUNNING if there is still data to be processed
- Watchable.NEEDS_DATA if there is no data to be processed but
the execution is not yet complete
- Watchable.COMPLETED if the execution is complete
public void run()
protected void setError(Exception error)
Set an error on this watchable
protected void setStatus(int status)
Set the status of this watchable
protected void setup()
Prepare for a set of iterations. Called before the first iterate() call
in a sequence. Subclasses should extend this method if they need to do
anything to setup.
public void stop()
Stop this watchable. Stop will cause all processing to cease,
and the watchable to be destroyed.
public void waitForFinish()
Wait for this watchable to finish