Package com.bc.ceres.core

Class PrintWriterProgressMonitor

java.lang.Object
com.bc.ceres.core.PrintWriterProgressMonitor
All Implemented Interfaces:
ProgressMonitor
Direct Known Subclasses:
PrintWriterConciseProgressMonitor
public class PrintWriterProgressMonitor extends Object implements ProgressMonitor
A progress monitor which prints progress using a PrintWriter.

  • Constructor Details

    • PrintWriterProgressMonitor

      public PrintWriterProgressMonitor(OutputStream output)

    • PrintWriterProgressMonitor

      public PrintWriterProgressMonitor(PrintWriter output)

  • Method Details

    • getTaskName

      public String getTaskName()

    • setTaskName

      public void setTaskName(String taskName)
      Description copied from interface: ProgressMonitor
      Sets the task name to the given value. This method is used to restore the task label after a nested operation was executed. Normally there is no need for clients to call this method.
      Specified by:
      setTaskName in interface ProgressMonitor
      Parameters:
      taskName - the name (or description) of the main task
      See Also:

    • getSubTaskName

      public String getSubTaskName()

    • setSubTaskName

      public void setSubTaskName(String subTaskName)
      Description copied from interface: ProgressMonitor
      Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.
      Specified by:
      setSubTaskName in interface ProgressMonitor
      Parameters:
      subTaskName - the name (or description) of the subtask

    • getPrintMinorStepPercentage

      public int getPrintMinorStepPercentage()

    • getPrintStepPercentage

      public int getPrintStepPercentage()

    • setPrintMinorStepPercentage

      public void setPrintMinorStepPercentage(int printMinorStepPercentage)

    • setPrintStepPercentage

      public void setPrintStepPercentage(int printStepPercentage)

    • getPercentageWorked

      public int getPercentageWorked()

    • beginTask

      public void beginTask(String name, int totalWork)
      Description copied from interface: ProgressMonitor
      Notifies that the main task is beginning. This must only be called once on a given progress monitor instance.
      Specified by:
      beginTask in interface ProgressMonitor
      Parameters:
      name - the name (or description) of the main task
      totalWork - the total number of work units into which the main task is been subdivided. If the value is UNKNOWN the implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.

    • done

      public void done()
      Description copied from interface: ProgressMonitor
      Notifies that the work is done; that is, either the main task is completed or the user canceled it. This method may be called more than once (implementations should be prepared to handle this case).
      Specified by:
      done in interface ProgressMonitor

    • worked

      public void worked(int work)
      Description copied from interface: ProgressMonitor
      Notifies that a given number of work unit of the main task has been completed. Note that this amount represents an installment, as opposed to a cumulative amount of work done to date.
      Specified by:
      worked in interface ProgressMonitor
      Parameters:
      work - the number of work units just completed

    • internalWorked

      public void internalWorked(double work)
      Description copied from interface: ProgressMonitor
      Internal method to handle scaling correctly. This method must not be called by a client. Clients should always use the method worked(int).
      Specified by:
      internalWorked in interface ProgressMonitor
      Parameters:
      work - the amount of work done

    • isCanceled

      public boolean isCanceled()
      Description copied from interface: ProgressMonitor
      Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.
      Specified by:
      isCanceled in interface ProgressMonitor
      Returns:
      true if cancellation has been requested, and false otherwise
      See Also:

    • setCanceled

      public void setCanceled(boolean canceled)
      Description copied from interface: ProgressMonitor
      Sets the cancel state to the given value.
      Specified by:
      setCanceled in interface ProgressMonitor
      Parameters:
      canceled - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag
      See Also:

    • printStartMessage

      protected void printStartMessage(PrintWriter pw)

    • printWorkedMessage

      protected void printWorkedMessage(PrintWriter pw)

    • printMinorWorkedMessage

      protected void printMinorWorkedMessage(PrintWriter pw)

    • printDoneMessage

      protected void printDoneMessage(PrintWriter pw)

    • printCanceledMessage

      protected void printCanceledMessage(PrintWriter pw)

    • getMessage

      protected String getMessage()