|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectvisad.util.CmdlineGenericConsumer
public class CmdlineGenericConsumer
Simple implementation of CmdlineConsumer interface which can be extended to easily add command-line parsing to an application.
Constructor Summary | |
---|---|
CmdlineGenericConsumer()
|
Method Summary | |
---|---|
int |
checkKeyword(java.lang.String mainName,
int thisArg,
java.lang.String[] args)
Handle subclass-specific command line options and their arguments. |
int |
checkOption(java.lang.String mainName,
char ch,
java.lang.String arg)
Handle subclass-specific command line options and their arguments. If -abc -d efg -h -1 -i is specified, this method will be called a maximum of 5 times: checkOption(mainName, 'a', "bc"); checkOption(mainName, 'd', "efg"); checkOption(mainName, 'h', "-1"); checkOption(mainName, '1', "-i"); checkOption(mainName, 'i', null); Note that either of the last two method calls may not happen if the preceeding method call claims to have used the following argument (by returning 2. For example, if the third call (where ch is set to 'h') returns 0 or 1, the next call will contain '1' and "-i". |
boolean |
finalizeArgs(java.lang.String mainName)
Validate arguments after argument parsing has finished. This is useful for verifying that all required keywords and options have been specified, that options don't conflict with one another, etc. |
void |
initializeArgs()
Method used to initialize any instance variables which may be changed by a cmdline option. This is needed when arguments are processed inside the constructor. |
java.lang.String |
keywordUsage()
A short string included in the usage message to indicate valid keywords. An example might be "[username] [password]". |
java.lang.String |
optionUsage()
A short string included in the usage message to indicate valid options. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CmdlineGenericConsumer()
Method Detail |
---|
public void initializeArgs()
CmdlineParser
will be run
before any instance variables for the extending
class are initialized.
initializeArgs
in interface CmdlineConsumer
public int checkOption(java.lang.String mainName, char ch, java.lang.String arg)
checkOption
in interface CmdlineConsumer
mainName
- The name of the main class (useful for
error messages.)ch
- Option character. If -a is specified
on the command line, 'a' would be passed to
this method.)arg
- The argument associated with this option.
public java.lang.String optionUsage()
optionUsage
in interface CmdlineConsumer
public int checkKeyword(java.lang.String mainName, int thisArg, java.lang.String[] args)
checkKeyword
in interface CmdlineConsumer
mainName
- The name of the main class (useful for
error messages.)thisArg
- The index of the current keyword.args
- The full list of arguments.
public java.lang.String keywordUsage()
keywordUsage
in interface CmdlineConsumer
public boolean finalizeArgs(java.lang.String mainName)
finalizeArgs
in interface CmdlineConsumer
mainName
- The name of the main class (useful for
error messages.)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |