Package com.compomics.util.gui.waiting.waitinghandlers

Class WaitingHandlerDummy

java.lang.Object
com.compomics.util.gui.waiting.waitinghandlers.WaitingHandlerDummy
All Implemented Interfaces:
WaitingHandler
public class WaitingHandlerDummy extends Object implements WaitingHandler
This class is an implementation of the WaitingHandler interface to be used when a process can be canceled, but no monitoring is needed. Hence only the methods related to setting and getting the status of the process are implemented.
Author:
Harald Barsnes

  • Constructor Details

    • WaitingHandlerDummy

      public WaitingHandlerDummy()
      Empty default constructor

  • Method Details

    • setMaxPrimaryProgressCounter

      public void setMaxPrimaryProgressCounter(int maxProgressValue)
      Description copied from interface: WaitingHandler
      Set the maximum value for the primary progress counter.
      Specified by:
      setMaxPrimaryProgressCounter in interface WaitingHandler
      Parameters:
      maxProgressValue - the max value

    • increasePrimaryProgressCounter

      public void increasePrimaryProgressCounter()
      Description copied from interface: WaitingHandler
      Increase the primary progress counter by one "counter".
      Specified by:
      increasePrimaryProgressCounter in interface WaitingHandler

    • increasePrimaryProgressCounter

      public void increasePrimaryProgressCounter(int value)
      Description copied from interface: WaitingHandler
      Increase the primary progress counter by the given increment.
      Specified by:
      increasePrimaryProgressCounter in interface WaitingHandler
      Parameters:
      value - the increment to increase the value by

    • setPrimaryProgressCounter

      public void setPrimaryProgressCounter(int value)
      Description copied from interface: WaitingHandler
      Sets the primary progress counter to the given value.
      Specified by:
      setPrimaryProgressCounter in interface WaitingHandler
      Parameters:
      value - the progress value

    • setMaxSecondaryProgressCounter

      public void setMaxSecondaryProgressCounter(int maxProgressValue)
      Description copied from interface: WaitingHandler
      Set the maximum value for the secondary progress counter.
      Specified by:
      setMaxSecondaryProgressCounter in interface WaitingHandler
      Parameters:
      maxProgressValue - the max value

    • resetSecondaryProgressCounter

      public void resetSecondaryProgressCounter()
      Description copied from interface: WaitingHandler
      Reset the secondary progress counter to 0.
      Specified by:
      resetSecondaryProgressCounter in interface WaitingHandler

    • increaseSecondaryProgressCounter

      public void increaseSecondaryProgressCounter()
      Description copied from interface: WaitingHandler
      Increase the secondary progress counter by one "counter".
      Specified by:
      increaseSecondaryProgressCounter in interface WaitingHandler

    • setSecondaryProgressCounter

      public void setSecondaryProgressCounter(int value)
      Description copied from interface: WaitingHandler
      Sets the secondary progress counter to the given value.
      Specified by:
      setSecondaryProgressCounter in interface WaitingHandler
      Parameters:
      value - the progress value

    • increaseSecondaryProgressCounter

      public void increaseSecondaryProgressCounter(int value)
      Description copied from interface: WaitingHandler
      Increase the secondary progress counter by the given value.
      Specified by:
      increaseSecondaryProgressCounter in interface WaitingHandler
      Parameters:
      value - the value to increase the value by

    • setSecondaryProgressCounterIndeterminate

      public void setSecondaryProgressCounterIndeterminate(boolean indeterminate)
      Description copied from interface: WaitingHandler
      Sets the secondary progress counter to indeterminate or not.
      Specified by:
      setSecondaryProgressCounterIndeterminate in interface WaitingHandler
      Parameters:
      indeterminate - if true, set to indeterminate

    • setRunFinished

      public void setRunFinished()
      Description copied from interface: WaitingHandler
      Set the process as finished.
      Specified by:
      setRunFinished in interface WaitingHandler

    • setRunCanceled

      public void setRunCanceled()
      Description copied from interface: WaitingHandler
      Set the process as canceled.
      Specified by:
      setRunCanceled in interface WaitingHandler

    • appendReport

      public void appendReport(String report, boolean includeDate, boolean addNewLine)
      Description copied from interface: WaitingHandler
      Append text to the report.
      Specified by:
      appendReport in interface WaitingHandler
      Parameters:
      report - the text to append
      includeDate - if the date and time is to be added to the front of the text
      addNewLine - add a new line after the text?

    • appendReportNewLineNoDate

      public void appendReportNewLineNoDate()
      Description copied from interface: WaitingHandler
      Append two tabs to the report. No new line.
      Specified by:
      appendReportNewLineNoDate in interface WaitingHandler

    • appendReportEndLine

      public void appendReportEndLine()
      Description copied from interface: WaitingHandler
      Append a new line to the report.
      Specified by:
      appendReportEndLine in interface WaitingHandler

    • isRunCanceled

      public boolean isRunCanceled()
      Description copied from interface: WaitingHandler
      Returns true if the run is canceled.
      Specified by:
      isRunCanceled in interface WaitingHandler
      Returns:
      true if the run is canceled

    • isRunFinished

      public boolean isRunFinished()
      Description copied from interface: WaitingHandler
      Returns true if the process is finished.
      Specified by:
      isRunFinished in interface WaitingHandler
      Returns:
      true if the process is finished

    • setWaitingText

      public void setWaitingText(String text)
      Description copied from interface: WaitingHandler
      Sets the text describing what is currently being waited for.
      Specified by:
      setWaitingText in interface WaitingHandler
      Parameters:
      text - a text describing what is currently waited for

    • setPrimaryProgressCounterIndeterminate

      public void setPrimaryProgressCounterIndeterminate(boolean indeterminate)
      Description copied from interface: WaitingHandler
      Sets whether the primary progress counter is indeterminate or not.
      Specified by:
      setPrimaryProgressCounterIndeterminate in interface WaitingHandler
      Parameters:
      indeterminate - a boolean indicating whether the primary progress counter is indeterminate or not

    • isReport

      public boolean isReport()
      Description copied from interface: WaitingHandler
      Indicates whether this waiting handler supports reports.
      Specified by:
      isReport in interface WaitingHandler
      Returns:
      a boolean indicating whether this waiting handler supports reports

    • setSecondaryProgressText

      public void setSecondaryProgressText(String text)
      Description copied from interface: WaitingHandler
      Set the secondary progress counter text.
      Specified by:
      setSecondaryProgressText in interface WaitingHandler
      Parameters:
      text - the text to set

    • resetPrimaryProgressCounter

      public void resetPrimaryProgressCounter()
      Description copied from interface: WaitingHandler
      Reset the primary progress counter to 0.
      Specified by:
      resetPrimaryProgressCounter in interface WaitingHandler

    • getPrimaryProgressCounter

      public int getPrimaryProgressCounter()
      Description copied from interface: WaitingHandler
      Returns the primary progress counter.
      Specified by:
      getPrimaryProgressCounter in interface WaitingHandler
      Returns:
      primary progress counter

    • getMaxPrimaryProgressCounter

      public int getMaxPrimaryProgressCounter()
      Description copied from interface: WaitingHandler
      Returns the max primary progress counter.
      Specified by:
      getMaxPrimaryProgressCounter in interface WaitingHandler
      Returns:
      max primary progress counter

    • getSecondaryProgressCounter

      public int getSecondaryProgressCounter()
      Description copied from interface: WaitingHandler
      Returns the secondary progress counter.
      Specified by:
      getSecondaryProgressCounter in interface WaitingHandler
      Returns:
      secondary progress counter

    • getMaxSecondaryProgressCounter

      public int getMaxSecondaryProgressCounter()
      Description copied from interface: WaitingHandler
      Returns the max secondary progress counter.
      Specified by:
      getMaxSecondaryProgressCounter in interface WaitingHandler
      Returns:
      max secondary progress counter

    • setDisplayProgress

      public void setDisplayProgress(boolean displayProgress)
      Description copied from interface: WaitingHandler
      Set if the waiting handler is to show the progress for the current process or not. Useful when running subprocesses that one wants to be able to cancel but do not want to show the progress for.
      Specified by:
      setDisplayProgress in interface WaitingHandler
      Parameters:
      displayProgress - if the waiting handler is to show the progress for the current process or not

    • getDisplayProgress

      public boolean getDisplayProgress()
      Description copied from interface: WaitingHandler
      Returns if the waiting handler is to show the progress for the current process or not. Useful when running subprocesses that one wants to be able to cancel but do not want to show the progress for.
      Specified by:
      getDisplayProgress in interface WaitingHandler
      Returns:
      if the waiting handler is to show the progress for the current process or not