|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.llnl.babel.UserOptions.BasicSwitch
gov.llnl.babel.UserOptions.HideGlueOffSwitch
Constructor Summary | |
UserOptions.HideGlueOffSwitch()
|
Method Summary | |
java.lang.String |
getArgumentName()
If the switch has an argument, what name should be used to identify it in the help text. |
java.lang.String |
getHelpText()
Return a brief string describing what this command line switch implies or does. |
java.lang.String |
getLongName()
Return the long option name, usually one or more words separated by hyphens. |
int |
getShortForm()
If the command line switch has a one character short form, return the character value as an integer. |
boolean |
hasOptionalArgument()
Return true if and only if, this command line switch
has an optional argument. |
boolean |
hasRequiredArgument()
Return true if and only if, this command line switch
requires an argument. |
boolean |
isHidden()
Return true if this command line option should be
hidden when the help text is generated. |
void |
processCommandSwitch(java.lang.String optarg)
This method is called when the Babel end user specifies this command line switch on the command line. |
void |
setShortForm(int v)
If the command line manager cannot support the short form you requested or if you did not specify the short form, this method will be called to set your short form. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public UserOptions.HideGlueOffSwitch()
Method Detail |
public final void processCommandSwitch(java.lang.String optarg)
CommandLineSwitch
optarg
- this argument will be null if the command line switch
doesn't take a required argument (i.e., CommandLineSwitch.hasRequiredArgument()
is false
) or if the command line switch takes an
optional argument (i.e., CommandLineSwitch.hasOptionalArgument()
is
true
) and an argument wasn't provided; otherwise, the
argument is a non-null string including the text from the command line.public final java.lang.String getLongName()
CommandLineSwitch
getLongName
in interface CommandLineSwitch
public final int getShortForm()
CommandLineSwitch
getShortForm
in interface CommandLineSwitch
public final void setShortForm(int v)
CommandLineSwitch
CommandLineSwitch.getShortForm()
is called in the future.
setShortForm
in interface CommandLineSwitch
v
- your object must return this value in
future calls to CommandLineSwitch.getShortForm()
.public final java.lang.String getHelpText()
CommandLineSwitch
getHelpText
in interface CommandLineSwitch
public java.lang.String getArgumentName()
CommandLineSwitch
getArgumentName
in interface CommandLineSwitch
public boolean hasRequiredArgument()
CommandLineSwitch
true
if and only if, this command line switch
requires an argument. If this method returns true
,
hasOptionalArgument should return false
.
hasRequiredArgument
in interface CommandLineSwitch
true
implies that the switch take an optional
argument; false
implies that it does not.public boolean hasOptionalArgument()
CommandLineSwitch
true
if and only if, this command line switch
has an optional argument. If this method returns true
,
hasRequiredArgument should return false
.
hasOptionalArgument
in interface CommandLineSwitch
true
implies that the switch takes an optional
argument; false
implies that it does not.public boolean isHidden()
CommandLineSwitch
true
if this command line option should be
hidden when the help text is generated.
isHidden
in interface CommandLineSwitch
true
means that this options requests to not
be printed with the help text.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |