public class CommandLineOptions
extends java.lang.Object
Constructor | Description |
---|---|
CommandLineOptions() |
Modifier and Type | Method | Description |
---|---|---|
void |
addFlag(java.lang.String flag) |
Adds the flag to list of available command line options
|
void |
addFlag(java.lang.String flag,
java.lang.String comment) |
Adds the flag to list of available command line options
|
void |
addFlag(java.lang.String flag,
java.lang.String usageText,
java.lang.String comment) |
Adds the flag to list of available command line options
|
java.util.Properties |
getOptions(java.lang.String[] args) |
parses the arguments into a hashtable with the proper flag
as the key
|
void |
printHelp(java.io.PrintWriter pw) |
|
void |
printUsage(java.io.PrintWriter pw) |
|
void |
setComment(java.lang.String flag,
java.lang.String comment) |
Sets a comment for the flag
|
void |
setInvokeCommand(java.lang.String invokeCommand) |
Sets the command used to invoke the application
|
void |
setOptional(java.lang.String flag,
boolean optional) |
Sets whether or not a given flag is optional
|
void |
setUsageInfo(java.lang.String flag,
java.lang.String usage) |
Sets the text to print after the flag when printing the usage line
|
public void addFlag(java.lang.String flag)
flag
- the flag to add as an available command line optionpublic void addFlag(java.lang.String flag, java.lang.String comment)
flag
- the flag to add as an available command line optioncomment
- a comment for the flagpublic void addFlag(java.lang.String flag, java.lang.String usageText, java.lang.String comment)
flag
- the flag to add as an available command line optioncomment
- a comment for the flagusageText
- the text that appears after the flag in the
usage stringpublic java.util.Properties getOptions(java.lang.String[] args)
public void setComment(java.lang.String flag, java.lang.String comment)
flag
- the flag to set the comment forcomment
- the comment to use when printing help for the given flagpublic void setOptional(java.lang.String flag, boolean optional)
flag
- the flag to set optionality foroptional
- the boolean indicating the optionality for the given flagpublic void setInvokeCommand(java.lang.String invokeCommand)
invokeCommand
- the command used to invoke the applicationpublic void setUsageInfo(java.lang.String flag, java.lang.String usage)
flag
- the flag to set the usage info forusage
- the usage textpublic void printUsage(java.io.PrintWriter pw)
public void printHelp(java.io.PrintWriter pw)