Class WaitingHandlerCLIImpl
java.lang.Object
com.compomics.util.gui.waiting.waitinghandlers.WaitingHandlerCLIImpl
- All Implemented Interfaces:
WaitingHandler
public class WaitingHandlerCLIImpl extends Object implements WaitingHandler
This class is an implementation of the WaitingHandler interface to be used
when operating through the Command Line Interface.
- Author:
- Harald Barsnes
-
Field Summary
Fields inherited from interface com.compomics.util.waiting.WaitingHandler
SIMPLE_DATA_FORMAT, TAB_HTML, TAB_NON_HTML
-
Constructor Summary
Constructors Constructor Description WaitingHandlerCLIImpl()
Empty default constructor -
Method Summary
Modifier and Type Method Description void
appendReport(String report, boolean includeDate, boolean addNewLine)
Append text to the report.void
appendReportEndLine()
Append a new line to the report.void
appendReportNewLineNoDate()
Append two tabs to the report.boolean
getDisplayProgress()
Returns if the waiting handler is to show the progress for the current process or not.int
getMaxPrimaryProgressCounter()
Returns the max primary progress counter.int
getMaxSecondaryProgressCounter()
Returns the max secondary progress counter.int
getPrimaryProgressCounter()
Returns the primary progress counter.int
getSecondaryProgressCounter()
Returns the secondary progress counter.void
increasePrimaryProgressCounter()
Increase the primary progress counter by one "counter".void
increasePrimaryProgressCounter(int value)
Increase the primary progress counter by the given increment.void
increaseSecondaryProgressCounter()
Increase the secondary progress counter by one "counter".void
increaseSecondaryProgressCounter(int value)
Increase the secondary progress counter by the given value.boolean
isReport()
Indicates whether this waiting handler supports reports.boolean
isRunCanceled()
Returns true if the run is canceled.boolean
isRunFinished()
Returns true if the process is finished.void
resetPrimaryProgressCounter()
Reset the primary progress counter to 0.void
resetSecondaryProgressCounter()
Reset the secondary progress counter to 0.void
setDisplayProgress(boolean displayProgress)
Set if the waiting handler is to show the progress for the current process or not.void
setMaxPrimaryProgressCounter(int maxProgressValue)
Set the maximum value for the primary progress counter.void
setMaxSecondaryProgressCounter(int maxProgressValue)
Set the maximum value for the secondary progress counter.void
setPrimaryProgressCounter(int value)
Sets the primary progress counter to the given value.void
setPrimaryProgressCounterIndeterminate(boolean indeterminate)
Sets whether the primary progress counter is indeterminate or not.void
setRunCanceled()
Set the process as canceled.void
setRunFinished()
Set the process as finished.void
setSecondaryProgressCounter(int value)
Sets the secondary progress counter to the given value.void
setSecondaryProgressCounterIndeterminate(boolean indeterminate)
Sets the secondary progress counter to indeterminate or not.void
setSecondaryProgressText(String text)
Set the secondary progress counter text.void
setWaitingText(String text)
Sets the text describing what is currently being waited for.
-
Field Details
-
iReport
The report to append.
-
-
Constructor Details
-
WaitingHandlerCLIImpl
public WaitingHandlerCLIImpl()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 interfaceWaitingHandler
- 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 interfaceWaitingHandler
-
increasePrimaryProgressCounter
public void increasePrimaryProgressCounter(int value)Description copied from interface:WaitingHandler
Increase the primary progress counter by the given increment.- Specified by:
increasePrimaryProgressCounter
in interfaceWaitingHandler
- 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 interfaceWaitingHandler
- 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 interfaceWaitingHandler
- 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 interfaceWaitingHandler
-
increaseSecondaryProgressCounter
public void increaseSecondaryProgressCounter()Description copied from interface:WaitingHandler
Increase the secondary progress counter by one "counter".- Specified by:
increaseSecondaryProgressCounter
in interfaceWaitingHandler
-
setSecondaryProgressCounter
public void setSecondaryProgressCounter(int value)Description copied from interface:WaitingHandler
Sets the secondary progress counter to the given value.- Specified by:
setSecondaryProgressCounter
in interfaceWaitingHandler
- 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 interfaceWaitingHandler
- 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 interfaceWaitingHandler
- 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 interfaceWaitingHandler
-
setRunCanceled
public void setRunCanceled()Description copied from interface:WaitingHandler
Set the process as canceled.- Specified by:
setRunCanceled
in interfaceWaitingHandler
-
appendReport
Description copied from interface:WaitingHandler
Append text to the report.- Specified by:
appendReport
in interfaceWaitingHandler
- Parameters:
report
- the text to appendincludeDate
- if the date and time is to be added to the front of the textaddNewLine
- 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 interfaceWaitingHandler
-
appendReportEndLine
public void appendReportEndLine()Description copied from interface:WaitingHandler
Append a new line to the report.- Specified by:
appendReportEndLine
in interfaceWaitingHandler
-
isRunCanceled
public boolean isRunCanceled()Description copied from interface:WaitingHandler
Returns true if the run is canceled.- Specified by:
isRunCanceled
in interfaceWaitingHandler
- 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 interfaceWaitingHandler
- Returns:
- true if the process is finished
-
setWaitingText
Description copied from interface:WaitingHandler
Sets the text describing what is currently being waited for.- Specified by:
setWaitingText
in interfaceWaitingHandler
- 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 interfaceWaitingHandler
- 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 interfaceWaitingHandler
- Returns:
- a boolean indicating whether this waiting handler supports reports
-
setSecondaryProgressText
Description copied from interface:WaitingHandler
Set the secondary progress counter text.- Specified by:
setSecondaryProgressText
in interfaceWaitingHandler
- 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 interfaceWaitingHandler
-
getPrimaryProgressCounter
public int getPrimaryProgressCounter()Description copied from interface:WaitingHandler
Returns the primary progress counter.- Specified by:
getPrimaryProgressCounter
in interfaceWaitingHandler
- Returns:
- primary progress counter
-
getMaxPrimaryProgressCounter
public int getMaxPrimaryProgressCounter()Description copied from interface:WaitingHandler
Returns the max primary progress counter.- Specified by:
getMaxPrimaryProgressCounter
in interfaceWaitingHandler
- Returns:
- max primary progress counter
-
getSecondaryProgressCounter
public int getSecondaryProgressCounter()Description copied from interface:WaitingHandler
Returns the secondary progress counter.- Specified by:
getSecondaryProgressCounter
in interfaceWaitingHandler
- Returns:
- secondary progress counter
-
getMaxSecondaryProgressCounter
public int getMaxSecondaryProgressCounter()Description copied from interface:WaitingHandler
Returns the max secondary progress counter.- Specified by:
getMaxSecondaryProgressCounter
in interfaceWaitingHandler
- 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 interfaceWaitingHandler
- 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 interfaceWaitingHandler
- Returns:
- if the waiting handler is to show the progress for the current process or not
-