Package adams.core.command

Interface ExternalCommandWithOptions

All Superinterfaces:

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

All Known Implementing Classes:

AbstractAsyncCapableExternalCommandWithOptions, AbstractExternalCommandWithOptions

public interface ExternalCommandWithOptions
extends ExternalCommand

Interface for external commands that take options.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String[]	getActualOptions()	Returns the actual options to use.
BaseString[]	getOptions()	Returns the options for the command.
BaseText	getOptionsString()	Returns the options for the command as single string.
String	optionsStringTipText()	Returns the tip text for this property.
String	optionsTipText()	Returns the tip text for this property.
void	setOptions(BaseString[] value)	Sets the options for the command.
void	setOptions(String[] value)	Sets the options for the command.
void	setOptions(List<String> value)	Sets the options for the command.
void	setOptionsString(BaseText value)	Sets the options for the command.
void	setOptionsString(String value)	Sets the options for the command.

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

setOptions

void setOptions(List<String> value)

Sets the options for the command.

Parameters:

value - the options

setOptions

void setOptions(String[] value)

Sets the options for the command.

Parameters:

value - the options

setOptions

void setOptions(BaseString[] value)

Sets the options for the command.

Parameters:

value - the options

getOptions

BaseString[] getOptions()

Returns the options for the command.

Returns:

the options

optionsTipText

String optionsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setOptionsString

void setOptionsString(String value)

Sets the options for the command.

Parameters:

value - the options

setOptionsString

void setOptionsString(BaseText value)

Sets the options for the command.

Parameters:

value - the options

getOptionsString

BaseText getOptionsString()

Returns the options for the command as single string.

Returns:

the options

optionsStringTipText

String optionsStringTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getActualOptions

String[] getActualOptions()

Returns the actual options to use. The options string takes precendence over the array.

Returns:

the options