Package com.pnfsoftware.jeb.util.interpreter

Class SimpleCommandManager

java.lang.Object

com.pnfsoftware.jeb.util.interpreter.SimpleCommandManager

All Implemented Interfaces:

ICommandManager, ICommandNode

public class SimpleCommandManager
extends Object
implements ICommandManager

A basic command manager that may be extended.

Field Summary

Fields inherited from interface com.pnfsoftware.jeb.util.interpreter.ICommandNode

QUOTES_AS_NORMAL_CHAR

Constructor Summary

Constructors

Constructor	Description
SimpleCommandManager()
SimpleCommandManager(ICommandManager parent, String name)

Method Summary

Modifier and Type	Method	Description
ICommandNode	addChild(ICommandNode node)
ExecutionResult	execute(String line)
ExecutionResult	execute(List<InputToken> tokens)	Execute the command.
List<ICommandNode>	getChildren()
String	getHelp()	Retrieve a short help that describes the command
String	getName()	Retrieve the name of the command (used to invoke the command)
int	getOptions()
ICommandManager	getParent()	Retrieve the parent, that is, this node's manager.
List<InputToken>	parseTokenString(String line)
protected ExecutionResult	postCheck()	Override to do command post-execution check.
protected ExecutionResult	preCheck()	Override to do command pre-execution check.

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleCommandManager

public SimpleCommandManager()

SimpleCommandManager

public SimpleCommandManager(ICommandManager parent,
 String name)

Method Details

getParent

public ICommandManager getParent()

Description copied from interface: ICommandNode

Retrieve the parent, that is, this node's manager.

Specified by:

getParent in interface ICommandNode

Returns:

getName

public String getName()

Description copied from interface: ICommandNode

Retrieve the name of the command (used to invoke the command)

Specified by:

getName in interface ICommandNode

Returns:

addChild

public ICommandNode addChild(ICommandNode node)

Specified by:

addChild in interface ICommandManager

getChildren

public List<ICommandNode> getChildren()

Specified by:

getChildren in interface ICommandNode

Returns:

getHelp

public String getHelp()

Description copied from interface: ICommandNode

Retrieve a short help that describes the command

Specified by:

getHelp in interface ICommandNode

Returns:

execute

public ExecutionResult execute(String line)

execute

public ExecutionResult execute(List<InputToken> tokens)

Description copied from interface: ICommandNode

Execute the command.

Specified by:

execute in interface ICommandNode

Returns:

preCheck

protected ExecutionResult preCheck()

Override to do command pre-execution check. The default implementation does nothing.

Returns:

an error to prevent the command from executing; null or a success to proceed with command execution

postCheck

protected ExecutionResult postCheck()

Override to do command post-execution check. Only executed if command execution succeeded. The default implementation does nothing.

Returns:

an error to prevent the command from executing; null or a success to proceed

parseTokenString

public List<InputToken> parseTokenString(String line)
                                  throws ParseException

Parameters:

line -

Returns:

Throws:

ParseException

getOptions

public int getOptions()

Specified by:

getOptions in interface ICommandNode

Returns: