org.jostraca.util
Class ExecutableCommand

java.lang.Object
  org.jostraca.util.ExecutableCommand

public class ExecutableCommand

extends java.lang.Object

Parameterised and fault-handling command executer.

Nested Class Summary

static class

ExecutableCommand.AlternativeExecutableCommands

Field Summary

static java.lang.String	CN
protected java.lang.String	iActivityDescription
protected boolean	iCmdNotFound
protected java.lang.String	iCmdPrefix
protected java.lang.String	iCmdRoot
protected java.lang.String	iCmdSuffix
protected java.lang.String	iErrResult
protected java.lang.String	iExecutedCmd
protected java.lang.String	iOutResult
protected ExecutableCommand	iParent
protected int	iStatus
protected UserMessageHandler	iUserMessageHandler

Constructor Summary

ExecutableCommand()
for anonymous subclasses

ExecutableCommand(ExecutableCommand pParent)
Used when alternative commands contain their own new ExecutableCommand objects

ExecutableCommand(java.lang.String pCmdPrefix)

ExecutableCommand(java.lang.String pCmdPrefix, ExecutableCommand pParent)

ExecutableCommand(java.lang.String pCmdPrefix, java.lang.String pCmdSuffix)

ExecutableCommand(java.lang.String pCmdPrefix, java.lang.String pCmdSuffix, ExecutableCommand pParent)

ExecutableCommand(java.lang.String pCmdPrefix, java.lang.String pCmdRoot, java.lang.String pCmdSuffix)

ExecutableCommand(java.lang.String pCmdPrefix, java.lang.String pCmdRoot, java.lang.String pCmdSuffix, ExecutableCommand pParent)

Method Summary

boolean	execute()
boolean	execute(ExecutableCommand.AlternativeExecutableCommands pAlternativeExecutableCommands) Throws StandardException if UserMessageHandler not set.
boolean	execute(ExecutableCommand pParent) Alternative commands are executed via this method.
int	getCmdLen()
java.lang.String	getCmdPrefix()
java.lang.String	getCmdRoot()
java.lang.String	getCmdSuffix()
java.lang.String	getErrResult()
java.lang.String	getExecutedCmd()
java.lang.String	getFullCmd()
java.lang.String	getOutResult()
int	getStatus()
boolean	hasErrResult()
boolean	hasOutResult()
void	setActivityDescription(java.lang.String pActivityDescription)
void	setUserMessageHandler(UserMessageHandler pUserMessageHandler) UserMessageHandler isnot required.
java.lang.String	toString()
boolean	wasNotFound()

Methods inherited from class java.lang.Object

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

Field Detail

CN

public static final java.lang.String CN

See Also:

Constant Field Values

iCmdPrefix

protected java.lang.String iCmdPrefix

iCmdRoot

protected java.lang.String iCmdRoot

iCmdSuffix

protected java.lang.String iCmdSuffix

iUserMessageHandler

protected UserMessageHandler iUserMessageHandler

iOutResult

protected java.lang.String iOutResult

iErrResult

protected java.lang.String iErrResult

iExecutedCmd

protected java.lang.String iExecutedCmd

iStatus

protected int iStatus

iActivityDescription

protected java.lang.String iActivityDescription

iParent

protected ExecutableCommand iParent

iCmdNotFound

protected boolean iCmdNotFound

Constructor Detail

ExecutableCommand

public ExecutableCommand()

for anonymous subclasses

ExecutableCommand

public ExecutableCommand(java.lang.String pCmdPrefix)

ExecutableCommand

public ExecutableCommand(java.lang.String pCmdPrefix,
                         java.lang.String pCmdSuffix)

ExecutableCommand

public ExecutableCommand(java.lang.String pCmdPrefix,
                         java.lang.String pCmdRoot,
                         java.lang.String pCmdSuffix)

ExecutableCommand

public ExecutableCommand(ExecutableCommand pParent)

Used when alternative commands contain their own new ExecutableCommand objects

ExecutableCommand

public ExecutableCommand(java.lang.String pCmdPrefix,
                         ExecutableCommand pParent)

ExecutableCommand

public ExecutableCommand(java.lang.String pCmdPrefix,
                         java.lang.String pCmdSuffix,
                         ExecutableCommand pParent)

ExecutableCommand

public ExecutableCommand(java.lang.String pCmdPrefix,
                         java.lang.String pCmdRoot,
                         java.lang.String pCmdSuffix,
                         ExecutableCommand pParent)

Method Detail

setUserMessageHandler

public void setUserMessageHandler(UserMessageHandler pUserMessageHandler)

UserMessageHandler isnot required.

setActivityDescription

public void setActivityDescription(java.lang.String pActivityDescription)

getCmdPrefix

public java.lang.String getCmdPrefix()

getCmdRoot

public java.lang.String getCmdRoot()

getCmdSuffix

public java.lang.String getCmdSuffix()

getFullCmd

public java.lang.String getFullCmd()

getCmdLen

public int getCmdLen()

execute

public boolean execute()

execute

public boolean execute(ExecutableCommand pParent)

Alternative commands are executed via this method. For subclasses, should be overridden. For alternative commands, grants access to parent.

execute

public boolean execute(ExecutableCommand.AlternativeExecutableCommands pAlternativeExecutableCommands)

Throws StandardException if UserMessageHandler not set. pAlternativeExecutableCommands not required, can be null.

getStatus

public int getStatus()

getOutResult

public java.lang.String getOutResult()

getErrResult

public java.lang.String getErrResult()

hasOutResult

public boolean hasOutResult()

hasErrResult

public boolean hasErrResult()

getExecutedCmd

public java.lang.String getExecutedCmd()

wasNotFound

public boolean wasNotFound()

toString

public java.lang.String toString()