org.apache.commons.cli
Class CommandLine

java.lang.Object
  |
  +--org.apache.commons.cli.CommandLine

public class CommandLine

extends java.lang.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)

Method Summary

java.util.List	getArgList() Retrieve any left-over non-recognized options and arguments
java.lang.String[]	getArgs() Retrieve any left-over non-recognized options and arguments
java.lang.Object	getOptionObject(char opt) Return the Object type of this Option.
java.lang.Object	getOptionObject(java.lang.String opt) Return the Object type of this Option.
Option[]	getOptions() Returns an array of the processed Options.
java.lang.String	getOptionValue(char opt) Retrieve the argument, if any, of this option.
java.lang.String	getOptionValue(char opt, java.lang.String defaultValue) Retrieve the argument, if any, of an option.
java.lang.String	getOptionValue(java.lang.String opt) Retrieve the argument, if any, of this option.
java.lang.String	getOptionValue(java.lang.String opt, java.lang.String defaultValue) Retrieve the argument, if any, of an option.
java.lang.String[]	getOptionValues(char opt) Retrieves the array of values, if any, of an option.
java.lang.String[]	getOptionValues(java.lang.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(java.lang.String opt) Query to see if an option has been set.
java.util.Iterator	iterator() Returns an iterator over the Option members of CommandLine.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

hasOption

public boolean hasOption(java.lang.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 java.lang.Object getOptionObject(java.lang.String opt)

Return the Object type of this Option.

Parameters:

opt - the name of the option

Returns:

the type of this Option

getOptionObject

public java.lang.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 java.lang.String getOptionValue(java.lang.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 java.lang.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 java.lang.String[] getOptionValues(java.lang.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.

getOptionValues

public java.lang.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 java.lang.String getOptionValue(java.lang.String opt,
                                       java.lang.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 java.lang.String getOptionValue(char opt,
                                       java.lang.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 java.lang.String[] getArgs()

Retrieve any left-over non-recognized options and arguments

Returns:

remaining items passed in but not parsed as an array

getArgList

public java.util.List getArgList()

Retrieve any left-over non-recognized options and arguments

Returns:

remaining items passed in but not parsed as a List.

iterator

public java.util.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.