Package com.pnfsoftware.jeb.util.interpreter

Class AbstractCommandHandler

java.lang.Object

com.pnfsoftware.jeb.util.interpreter.AbstractCommandHandler

All Implemented Interfaces:

ICommandHandler, ICommandNode

public abstract class AbstractCommandHandler
extends Object
implements ICommandHandler

Skeleton for a command handler.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	help
protected String	helpDetails
protected String	name
protected List<CommandParameter>	params
protected ICommandManager	parent

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

QUOTES_AS_NORMAL_CHAR

Constructor Summary

Constructors

Constructor	Description
AbstractCommandHandler(ICommandManager parent, String name)
AbstractCommandHandler(ICommandManager parent, String name, CommandParameter[] params, String help, String helpDetails)
AbstractCommandHandler(ICommandManager parent, String name, String help)
AbstractCommandHandler(ICommandManager parent, String name, String[] paramNames, String help, String helpDetails)

Method Summary

Modifier and Type	Method	Description
AbstractCommandHandler	addParameter(CommandParameter parameter)
AbstractCommandHandler	addParameter(String paramName)
List<ICommandNode>	getChildren()
String	getHelp()	Retrieve a short help that describes the command
String	getHelpDetails()	Give additional details (used when "help $command" is called).
String	getName()	Retrieve the name of the command (used to invoke the command)
int	getOptions()
static String	getParameter(List<InputToken> tokens, int i)	Get a parameter.
int	getParameterIndex(String paramName, String prefix)
List<CommandParameter>	getParameters()	Retrieve the list of parameters available for this command
static String	getParameterSafe(List<InputToken> tokens, int i)	Get a parameter, never return null.
ICommandManager	getParent()	Retrieve the parent, that is, this node's manager.
static InputToken	getToken(List<InputToken> tokens, int i)
InputToken[]	parseInputToken(List<InputToken> tokens)
InputToken[]	parseInputToken(List<InputToken> tokens, boolean failOnErrors)	Assign the inputToken value in the same index as inner CommandParameter list.
protected void	setHelp(String help)
protected void	setName(String name)
AbstractCommandHandler	setOptions(int options)
String	toString()

Methods inherited from class java.lang.Object

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

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

execute

Field Details

parent

protected ICommandManager parent

name

protected String name

params

protected List<CommandParameter> params

help

protected String help

helpDetails

protected String helpDetails

Constructor Details

AbstractCommandHandler

public AbstractCommandHandler(ICommandManager parent,
 String name)

AbstractCommandHandler

public AbstractCommandHandler(ICommandManager parent,
 String name,
 String help)

AbstractCommandHandler

public AbstractCommandHandler(ICommandManager parent,
 String name,
 String[] paramNames,
 String help,
 String helpDetails)

AbstractCommandHandler

public AbstractCommandHandler(ICommandManager parent,
 String name,
 CommandParameter[] params,
 String help,
 String helpDetails)

Method Details

parseInputToken

public InputToken[] parseInputToken(List<InputToken> tokens)

parseInputToken

public InputToken[] parseInputToken(List<InputToken> tokens,
 boolean failOnErrors)

Assign the inputToken value in the same index as inner CommandParameter list. Note that the result array can have a bigger size than inner CommandParameter list if the last CommandParameter item allow Multiple parameters.

Parameters:

failOnErrors - set to false if you allow missing parameter after a prefixed parameter (used for autocompletion) or missing mandatory parameters

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:

getChildren

public List<ICommandNode> getChildren()

Specified by:

getChildren 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:

setName

protected void setName(String name)

getHelp

public String getHelp()

Description copied from interface: ICommandNode

Retrieve a short help that describes the command

Specified by:

getHelp in interface ICommandNode

Returns:

setHelp

protected void setHelp(String help)

getHelpDetails

public String getHelpDetails()

Description copied from interface: ICommandHandler

Give additional details (used when "help $command" is called). Please provide the most details to help user: any trick, return format.

Specified by:

getHelpDetails in interface ICommandHandler

getParameters

public List<CommandParameter> getParameters()

Description copied from interface: ICommandHandler

Retrieve the list of parameters available for this command

Specified by:

getParameters in interface ICommandHandler

getParameterIndex

public int getParameterIndex(String paramName,
 String prefix)

addParameter

public AbstractCommandHandler addParameter(String paramName)

addParameter

public AbstractCommandHandler addParameter(CommandParameter parameter)

toString

public String toString()

Overrides:

toString in class Object

getToken

public static InputToken getToken(List<InputToken> tokens,
 int i)

getParameter

public static String getParameter(List<InputToken> tokens,
 int i)

Get a parameter.

Parameters:

tokens -

i -

Returns:

the parameter, null on error

getParameterSafe

public static String getParameterSafe(List<InputToken> tokens,
 int i)

Get a parameter, never return null.

Parameters:

tokens -

i -

Returns:

the parameter, or the empty string on error

getOptions

public int getOptions()

Specified by:

getOptions in interface ICommandNode

Returns:

setOptions

public AbstractCommandHandler setOptions(int options)