Package adams.flow.control.flowrestart.operation

Class ExternalCommand

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.control.flowrestart.operation.AbstractRestartOperation

adams.flow.control.flowrestart.operation.ExternalCommand

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class ExternalCommand
extends AbstractRestartOperation

Executes an external command, eg systemd or Windows service.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseCommandLine	m_Command	the command to execute.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ExternalCommand()

Method Summary

Modifier and Type	Method	Description
String	commandTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
BaseCommandLine	getCommand()	Returns the external command.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	restart(Flow flow)	Restarts the flow.
void	setCommand(BaseCommandLine value)	Sets the external command.

Methods inherited from class adams.flow.control.flowrestart.operation.AbstractRestartOperation

stopFlow

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Command

protected BaseCommandLine m_Command

the command to execute.

Constructor Detail

ExternalCommand

public ExternalCommand()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setCommand

public void setCommand(BaseCommandLine value)

Sets the external command.

Parameters:

value - the command

getCommand

public BaseCommandLine getCommand()

Returns the external command.

Returns:

the command

commandTipText

public String commandTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractRestartOperation

Returns:

null if no info available, otherwise short string

restart

public String restart(Flow flow)

Restarts the flow.

Specified by:

restart in class AbstractRestartOperation

Parameters:

flow - the flow to handle

Returns:

null if successfully restarted, otherwise the error message