Package com.pnfsoftware.jeb.util.interpreter

Class CommandParameter

java.lang.Object

com.pnfsoftware.jeb.util.interpreter.CommandParameter

public class CommandParameter
extends Object

Definition of a command's parameter. Each parameter can have a small description and be defined as prefixed or not: for example "-r" is a prefix with no name, "-t threadId" is a prefix with name and "thread" is a name without prefix.

Constructor Summary

Constructors

Constructor	Description
CommandParameter(String name)
CommandParameter(String name, boolean optional)
CommandParameter(String name, String help, boolean optional)
CommandParameter(String name, String help, boolean optional, boolean allowMultipleTokens)
CommandParameter(String name, String help, boolean optional, boolean allowMultipleTokens, IAutocompleteListProvider autocompleteProvider)
CommandParameter(String prefix, String name, String help, boolean optional)

Method Summary

Modifier and Type	Method	Description
boolean	allowMultipleTokens()
IAutocompleteListProvider	getAutocompleteProvider()
String	getHelp()	Help text
String	getName()	Name of the parameter.
String	getPrefix()	Short prefix (one letter by preference)
boolean	hasPrefix()
boolean	isOptional()	Whether parameter is optional or mandatory.

Methods inherited from class java.lang.Object

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

Constructor Details

CommandParameter

public CommandParameter(String name)

CommandParameter

public CommandParameter(String name,
 boolean optional)

CommandParameter

public CommandParameter(String name,
 String help,
 boolean optional)

CommandParameter

public CommandParameter(String prefix,
 String name,
 String help,
 boolean optional)

CommandParameter

public CommandParameter(String name,
 String help,
 boolean optional,
 boolean allowMultipleTokens)

CommandParameter

public CommandParameter(String name,
 String help,
 boolean optional,
 boolean allowMultipleTokens,
 IAutocompleteListProvider autocompleteProvider)

Method Details

hasPrefix

public boolean hasPrefix()

getPrefix

public String getPrefix()

Short prefix (one letter by preference)

getName

public String getName()

Name of the parameter. Can be empty only if parameter is a meaningful standalone prefix ("-r" for recursive for example)

getHelp

public String getHelp()

Help text

isOptional

public boolean isOptional()

Whether parameter is optional or mandatory.

getAutocompleteProvider

public IAutocompleteListProvider getAutocompleteProvider()

allowMultipleTokens

public boolean allowMultipleTokens()