AsyncCapableExternalCommand (adams-pom 24.12.0-SNAPSHOT API)

All Superinterfaces:

CleanUpHandler, Destroyable, ExternalCommand, FlowContextHandler, OptionHandler, QuickInfoSupporter, Stoppable, StoppableWithFeedback

All Known Implementing Classes:

AbstractAsyncCapableExternalCommand, AbstractAsyncCapableExternalCommandWithOptions
```
public interface AsyncCapableExternalCommand
extends ExternalCommand
```
Interface for external commands that support asynchronous mode.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addStdErr(String line)`	Adds the line received on stderr from the command.
`void`	`addStdOut(String line)`	Adds the line received on stdout from the command.
`String`	`blockingTipText()`	Returns the tip text for this property.
`boolean`	`getBlocking()`	Returns whether to execute in blocking or async fashion.
`void`	`setBlocking(boolean value)`	Sets whether to execute in blocking or async fashion.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.command.ExternalCommand
addFormattedOutput, cleanUp, execute, generates, getLastCommand, getOutputFormatter, getOutputType, getStdErrProcessor, getStdOutProcessor, hasLastCommand, hasOutput, isExecuted, isFinished, isRunning, isUsingBlocking, output, outputFormatterTipText, outputTypeTipText, setOutputFormatter, setOutputType, setStdErrProcessor, setStdOutProcessor, stdErrProcessorTipText, stdOutProcessorTipText

Methods inherited from interface adams.flow.core.FlowContextHandler
getFlowContext, setFlowContext

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.QuickInfoSupporter
getQuickInfo

Methods inherited from interface adams.core.Stoppable
stopExecution

Methods inherited from interface adams.core.StoppableWithFeedback
isStopped

- Method Detail
  - setBlocking
```
void setBlocking(boolean value)
```
    Sets whether to execute in blocking or async fashion.
    
    Parameters:
    
    value - true for blocking
  - getBlocking
```
boolean getBlocking()
```
    Returns whether to execute in blocking or async fashion.
    
    Returns:
    
    true for blocking
  - blockingTipText
```
String blockingTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - addStdOut
```
void addStdOut(String line)
```
    Adds the line received on stdout from the command.
    
    Parameters:
    
    line - the line to add
  - addStdErr
```
void addStdErr(String line)
```
    Adds the line received on stderr from the command.
    
    Parameters:
    
    line - the line to add