org.apache.commons.cli
public class CommandLine extends Object
Represents list of arguments parsed against a {@link Options} descriptor.
It allows querying of a boolean {@link #hasOption(String opt)}, in addition to retrieving the {@link #getOptionValue(String opt)} for options requiring arguments.
Additionally, any left-over or unrecognized arguments, are available for further processing.
Field Summary | |
---|---|
List | args the unrecognised options/arguments |
Map | hashcodeMap Map of unique options for ease to get complete list of options |
Map | options the processed options |
Option[] | optionsArray the processed options |
Constructor Summary | |
---|---|
CommandLine() Creates a command line. |
Method Summary | |
---|---|
void | addArg(String arg) Add left-over unrecognized option/argument. |
void | addOption(Option opt) Add an option to the command line. |
List | getArgList() Retrieve any left-over non-recognized options and arguments |
String[] | getArgs() Retrieve any left-over non-recognized options and arguments |
Object | getOptionObject(String opt) Return the |
Object | getOptionObject(char opt) Return the |
Option[] | getOptions() Returns an array of the processed {@link Option}s. |
String | getOptionValue(String opt) Retrieve the argument, if any, of this option. |
String | getOptionValue(char opt) Retrieve the argument, if any, of this option. |
String | getOptionValue(String opt, String defaultValue) Retrieve the argument, if any, of an option. |
String | getOptionValue(char opt, String defaultValue) Retrieve the argument, if any, of an option. |
String[] | getOptionValues(String opt) Retrieves the array of values, if any, of an option. |
String[] | getOptionValues(char opt) Retrieves the array of values, if any, of an option. |
boolean | hasOption(String opt) Query to see if an option has been set. |
boolean | hasOption(char opt) Query to see if an option has been set. |
Iterator | iterator() Returns an iterator over the Option members of CommandLine. |
Creates a command line.
Add left-over unrecognized option/argument.
Parameters: arg the unrecognised option/argument.
Add an option to the command line. The values of the option are stored.
Parameters: opt the processed option
Retrieve any left-over non-recognized options and arguments
Returns: remaining items passed in but not parsed as a List
.
Retrieve any left-over non-recognized options and arguments
Returns: remaining items passed in but not parsed as an array
Return the Object
type of this Option
.
Parameters: opt the name of the option
Returns: the type of this Option
Return the Object
type of this Option
.
Parameters: opt the name of the option
Returns: the type of opt
Returns an array of the processed {@link Option}s.
Returns: an array of the processed {@link Option}s.
Retrieve the argument, if any, of this option.
Parameters: opt the name of the option
Returns: Value of the argument if option is set, and has an argument, otherwise null.
Retrieve the argument, if any, of this option.
Parameters: opt the character name of the option
Returns: Value of the argument if option is set, and has an argument, otherwise null.
Retrieve the argument, if any, of an option.
Parameters: opt name of the option defaultValue is the default value to be returned if the option is not specified
Returns: Value of the argument if option is set, and has an argument,
otherwise defaultValue
.
Retrieve the argument, if any, of an option.
Parameters: opt character name of the option defaultValue is the default value to be returned if the option is not specified
Returns: Value of the argument if option is set, and has an argument,
otherwise defaultValue
.
Retrieves the array of values, if any, of an option.
Parameters: opt string name of the option
Returns: Values of the argument if option is set, and has an argument, otherwise null.
Retrieves the array of values, if any, of an option.
Parameters: opt character name of the option
Returns: Values of the argument if option is set, and has an argument, otherwise null.
Query to see if an option has been set.
Parameters: opt Short name of the option
Returns: true if set, false if not
Query to see if an option has been set.
Parameters: opt character name of the option
Returns: true if set, false if not
Returns an iterator over the Option members of CommandLine.
Returns: an Iterator
over the processed {@link Option}
members of this {@link CommandLine}