Class TextProgressIndicator

Method Details

• startStage

  public void startStage(String stage)

  Description copied from interface: ProgressIndicator

  Indicates that a number of ProgressIndicator.setLevel(double) calls may follow, followed by a ProgressIndicator.endStage() call.

  Specified by:

  startStage in interface ProgressIndicator

  Parameters:

  stage - name/description of the processing stage

• setLevel

  public void setLevel(double level)

  Description copied from interface: ProgressIndicator

  Specifies that the work of the most recently-started stage is a certain proportion complete. Calls to this method must take place between paired calls to ProgressIndicator.startStage(java.lang.String) and ProgressIndicator.endStage(), preferably with non-decreasing values of level.

  The method may throw an InterruptedException as a message to the caller that the work should be interrupted. A caller which receives such an exception should stop using resources and tidy up as soon as is convenient.

  Specified by:

  setLevel in interface ProgressIndicator

  Parameters:

  level - value between 0. and 1. indicating amount of completion

• endStage

  public void endStage()

  Description copied from interface: ProgressIndicator

  Indicates that no more ProgressIndicator.setLevel(double) calls will be made until the next ProgressIndicator.startStage(java.lang.String).

  Specified by:

  endStage in interface ProgressIndicator

• logMessage

  public void logMessage(String msg)

  Description copied from interface: ProgressIndicator

  Registers a comment about the progress of the algorithm. This should not be called between calls to ProgressIndicator.startStage(java.lang.String) and ProgressIndicator.endStage().

  Specified by:

  logMessage in interface ProgressIndicator

  Parameters:

  msg - message

• createInstance

  public static TextProgressIndicator createInstance(PrintStream out, boolean hasTime, boolean hasMem)

  Creates a TextProgressIndicator.

  Parameters:

  out - output stream

  hasTime - true to write time profile messages

  hasMem - true to write memory profile messages; note this calls System.gc() so may slow things down

  Returns:

  indicator instance