org.apache.commons.cli
Class CommandLine

java.lang.Object
  extended by org.apache.commons.cli.CommandLine

public class CommandLine
extends Object

Represents list of arguments parsed against a Options descriptor.

It allows querying of a boolean hasOption(String opt), in addition to retrieving the getOptionValue(String opt) for options requiring arguments.

Additionally, any left-over or unrecognized arguments, are available for further processing.

Author:
bob mcwhirter (bob @ werken.com), James Strachan, John Keyes (john at integralsource.com)

Field Summary
private  List args
          the unrecognised options/arguments
private  Set options
          the processed options
 
Constructor Summary
CommandLine()
          Creates a command line.
 
Method Summary
(package private)  void addArg(String arg)
          Add left-over unrecognized option/argument.
(package private)  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(char opt)
          Return the Object type of this Option.
 Object getOptionObject(String opt)
          Return the Object type of this Option.
 Option[] getOptions()
          Returns an array of the processed Options.
 String getOptionValue(char opt)
          Retrieve the argument, if any, of this option.
 String getOptionValue(char opt, String defaultValue)
          Retrieve the argument, if any, of an option.
 String getOptionValue(String opt)
          Retrieve the argument, if any, of this option.
 String getOptionValue(String opt, String defaultValue)
          Retrieve the argument, if any, of an option.
 String[] getOptionValues(char opt)
          Retrieves the array of values, if any, of an option.
 String[] getOptionValues(String opt)
          Retrieves the array of values, if any, of an option.
 boolean hasOption(char opt)
          Query to see if an option has been set.
 boolean hasOption(String opt)
          Query to see if an option has been set.
 Iterator iterator()
          Returns an iterator over the Option members of CommandLine.
private  Option resolveOption(String opt)
          Retrieves the option object given the long or short option as a String
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

args

private List args
the unrecognised options/arguments


options

private Set options
the processed options

Constructor Detail

CommandLine

CommandLine()
Creates a command line.

Method Detail

hasOption

public boolean hasOption(String opt)
Query to see if an option has been set.

Parameters:
opt - Short name of the option
Returns:
true if set, false if not

hasOption

public boolean hasOption(char opt)
Query to see if an option has been set.

Parameters:
opt - character name of the option
Returns:
true if set, false if not

getOptionObject

public Object getOptionObject(String opt)
Return the Object type of this Option.

Parameters:
opt - the name of the option
Returns:
the type of this Option

getOptionObject

public Object getOptionObject(char opt)
Return the Object type of this Option.

Parameters:
opt - the name of the option
Returns:
the type of opt

getOptionValue

public String getOptionValue(String opt)
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.

getOptionValue

public String getOptionValue(char opt)
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.

getOptionValues

public String[] getOptionValues(String opt)
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.

resolveOption

private Option resolveOption(String opt)

Retrieves the option object given the long or short option as a String

Parameters:
opt - short or long name of the option
Returns:
Canonicalized option

getOptionValues

public String[] getOptionValues(char opt)
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.

getOptionValue

public String getOptionValue(String opt,
                             String defaultValue)
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.

getOptionValue

public String getOptionValue(char opt,
                             String 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.

getArgs

public String[] getArgs()
Retrieve any left-over non-recognized options and arguments

Returns:
remaining items passed in but not parsed as an array

getArgList

public List getArgList()
Retrieve any left-over non-recognized options and arguments

Returns:
remaining items passed in but not parsed as a List.

addArg

void addArg(String arg)
Add left-over unrecognized option/argument.

Parameters:
arg - the unrecognised option/argument.

addOption

void addOption(Option opt)
Add an option to the command line. The values of the option are stored.

Parameters:
opt - the processed option

iterator

public Iterator iterator()
Returns an iterator over the Option members of CommandLine.

Returns:
an Iterator over the processed Option members of this CommandLine

getOptions

public Option[] getOptions()
Returns an array of the processed Options.

Returns:
an array of the processed Options.