|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.martiansoftware.jsap.Parameter
Top-level abstraction of a parameter. A parameter consists of one or more arguments (command line tokens) that have a special meaning when taken together. For example, a command-line switch "-v" is a parameter consisting of a single argument, whereas a command-line option "--file somefile.txt" is a parameter consisting of two arguments. Some parameters can be quite large, such as an option for a file compression utility that allows you to specify any number of files to comporess.
This is an abstract class. See its subclasses Switch
,
FlaggedOption
, and UnflaggedOption
for details on the various types of parameters. Functionality common to all three
types of Parameters is described below.
Each parameter has a unique ID assigned in its constructor. This ID is
used to retrieve values from the parser after the command line is parsed.
You can set the ID to any String value you wish, although in general you'll
want them to be brief and descriptive to provide a degree of documentation.
A "-h" switch, for example, might have the ID "help".
The calling program can then determine if the user specified the -h switch on
the command line with the simple call getBoolean("help")
against
the JSAPResult object produced by JSAP.parse().
Switch
,
FlaggedOption
,
UnflaggedOption
,
JSAPResult.getBoolean(String)
,
JSAP.parse(String[])
Constructor Summary | |
Parameter(String id)
Creates a new Parameter. |
Method Summary | |
void |
addDefault(String defaultValue)
Adds a single default value to any currently defined for this parameter. |
String[] |
getDefault()
Returns an array of default values for this parameter, or null if no default values have been defined. |
String |
getHelp()
Returns a description of the option's usage. |
String |
getID()
Returns this parameter's unique ID. |
abstract String |
getSyntax()
A convenience method for automatically generating syntax information based upon a JSAP configuration. |
String |
getUsage()
Deprecated. use getSyntax() instead |
String |
getUsageName()
Returns the name of this AbstractParameter for the purposes of usage information. |
Parameter |
setHelp(String help)
Sets the help text for this parameter. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Parameter(String id)
id
- The ID for this argument. All arguments MUST have
a unique ID.Method Detail |
public String getID()
public final void addDefault(String defaultValue)
defaultValue
- the default value to add to this parameter.public final String getUsageName()
public final String[] getDefault()
public abstract String getSyntax()
public final String getUsage()
public final String getHelp()
public final Parameter setHelp(String help)
help
- the help text for this parameter.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |