Package com.pnfsoftware.jeb.util.interpreter

Interface ICommandHandler

All Superinterfaces:

ICommandNode

All Known Implementing Classes:

AbstractCommandHandler

public interface ICommandHandler
extends ICommandNode

Definition of a command handler.

Field Summary

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

QUOTES_AS_NORMAL_CHAR

Method Summary

Modifier and Type	Method	Description
String	getHelpDetails()	Give additional details used when help <command> is called, such as usage notes or return format details.
List<CommandParameter>	getParameters()	Retrieve the list of parameters available for this command

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

execute, getChildren, getHelp, getName, getOptions, getParent

Method Details

getParameters

List<CommandParameter> getParameters()

Retrieve the list of parameters available for this command

Returns:

the command parameters, in parsing order

getHelpDetails

String getHelpDetails()

Give additional details used when help <command> is called, such as usage notes or return format details.

Returns:

extended help text, or an empty string if none is available