| java.lang.Object
 com.mchange.v2.cmdline.CommandLineUtils
| CommandLineUtils | | final public class CommandLineUtils (Code) | | |
| Method Summary | |
| public static ParsedCommandLine | parse(String[] argv, String switchPrefix, String[] validSwitches, String[] requiredSwitches, String[] argSwitches)
"Parses" a command line by making use several conventions:
- Certain arguments are considered "switches", by virtue
of being prefixed with some string, usually "-", "/", or "--"
- Switches may have arguments associated with them.
|
| parse | | public static ParsedCommandLine parse(String[] argv, String switchPrefix, String[] validSwitches, String[] requiredSwitches, String[] argSwitches) throws BadCommandLineException(Code) | | "Parses" a command line by making use several conventions:
- Certain arguments are considered "switches", by virtue
of being prefixed with some string, usually "-", "/", or "--"
- Switches may have arguments associated with them. This implementation
permits only a single argument per switch
- Switch arguments are determined via two conventions:
- If a switch is of the form "--switch=value" (where "--" is
set as the switch prefix), value is the switches argument.
- If a switch is not of this form (simply "--switch"), then the
following item on the command line is considered the switch's
argument if and only if
- the argSwitches array contains the switch, and
- the next item on the command line is not itself a switch
Parameters:
argv - the entire list of arguments, usually the argument to a main function
Parameters:
switchPrefix - the string which separates "switches" from regular command line args.Must be non-null
Parameters:
validSwitches - a list of all the switches permissible for this command line.If non-null, an UnexpectedSwitchException will be thrown if a switch notin this list is encountered. Use null to accept any switches.
Parameters:
requiredSwitches - a list of all the switches required by this command line.If non-null, an MissingSwitchException will be thrown if a switchin this list is not present. Use null if no switches should be considered required.
Parameters:
argSwitches - a list of switches that should have an argument associated with themIf non-null, an MissingSwitchArgumentException will be thrown if a switchin this list has no argument is not present. Use null if no switches should be considered to require arguments. However, this parameter is required if distinct items on a command line should be considered arguments to precedingitems. (For example, "f" must be an argSwitch for "-f myfile.txt" to be parsedas switch and argument, but argSwitches is not required to parse "--file=myfile.txt" |
|
|