public class

CommandParameter

extends Object
java.lang.Object
   ↳ com.pnfsoftware.jeb.util.interpreter.CommandParameter

Class Overview

Definition of a parameter from an interpreter. 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.

Summary

Public Constructors
CommandParameter(String name)
CommandParameter(String name, boolean optional)
CommandParameter(String name, String help, boolean optional)
CommandParameter(String prefix, 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)
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public CommandParameter (String name)

public CommandParameter (String name, boolean optional)

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

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

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

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

Public Methods

public boolean allowMultipleTokens ()

public IAutocompleteListProvider getAutocompleteProvider ()

public String getHelp ()

Help text

public String getName ()

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

public String getPrefix ()

Short prefix (one letter by preference)

public boolean hasPrefix ()

public boolean isOptional ()

Whether parameter is optional or mandatory.