Package org.loboevolution.pdfview

Class BaseWatchable

java.lang.Object
org.loboevolution.pdfview.BaseWatchable
All Implemented Interfaces:
Runnable, Watchable
Direct Known Subclasses:
PDFParser, PDFRenderer
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.

  • Field Summary

    Fields inherited from interface org.loboevolution.pdfview.Watchable

    COMPLETED, ERROR, NEEDS_DATA, NOT_STARTED, PAUSED, RUNNING, STOPPED, UNKNOWN

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    BaseWatchable()
    Creates a new instance of BaseWatchable

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    cleanup()
    Clean up after a set of iterations.
    protected void
    execute(boolean synchronous)
    Start executing this watchable
    static PDFErrorHandler
    getErrorHandler()
    Getter for the field errorHandler.
    int
    getStatus()
    Get the status of this watchable
    void
    go()
    Start this watchable and run 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.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • BaseWatchable

      protected BaseWatchable()
      Creates a new instance of BaseWatchable

  • Method Details

    • getErrorHandler

      public static PDFErrorHandler getErrorHandler()

      Getter for the field errorHandler.

      Returns:
      a PDFErrorHandler object.

    • iterate

      protected abstract int iterate() throws Exception
      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
      Throws:
      Exception - if any.

    • setup

      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.

    • cleanup

      protected void cleanup()
      Clean up after a set of iterations. Called after iteration has stopped due to completion, manual stopping, or error.

    • run

      public void run()
      Specified by:
      run in interface Runnable

    • getStatus

      public int getStatus()
      Get the status of this watchable

      Get the status of this watchable

      Specified by:
      getStatus in interface Watchable
      Returns:
      one of the well-known statuses

    • setStatus

      protected void setStatus(int status)
      Set the status of this watchable
      Parameters:
      status - a Integer object.

    • isFinished

      public boolean isFinished()
      Return whether this watchable has finished. A watchable is finished when its status is either COMPLETED, STOPPED or ERROR
      Returns:
      a boolean.

    • isExecutable

      public boolean isExecutable()
      return true if this watchable is ready to be executed
      Returns:
      a boolean.

    • stop

      public void stop()
      Stop this watchable. Stop will cause all processing to cease, and the watchable to be destroyed.

      Stop this watchable if it is not already finished. Stop will cause all processing to cease, and the watchable to be destroyed.

      Specified by:
      stop in interface Watchable

    • go

      public void go()
      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.

      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.

      Specified by:
      go in interface Watchable

    • go

      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

    • go

      public void go(int steps)
      Start this watchable and run for the given number of steps or until finished or stopped.

      Start this watchable and run for the given number of steps or until finished or stopped.

      Specified by:
      go in interface Watchable
      Parameters:
      steps - the number of steps to run for

    • go

      public void go(long millis)
      Start this watchable and run for the given amount of time, or until finished or stopped.

      Start this watchable and run for the given amount of time, or until finished or stopped.

      Specified by:
      go in interface Watchable
      Parameters:
      millis - the number of milliseconds to run for

    • execute

      protected void execute(boolean synchronous)
      Start executing this watchable
      Parameters:
      synchronous - if true, run in this thread

    • setError

      protected void setError(Exception error)
      Set an error on this watchable
      Parameters:
      error - a Exception object.