CommandLine (Commons CLI2 2.0-SNAPSHOT API)

All Known Subinterfaces:

WriteableCommandLine

All Known Implementing Classes:

CommandLineImpl, DefaultingCommandLine, PreferencesCommandLine, PropertiesCommandLine, WriteableCommandLineImpl
```
public interface CommandLine
```
Instances of CommandLine represent a command line that has been processed according to the definition supplied to the parser.

Method Summary

Methods
Modifier and Type	Method and Description
`Option`	`getOption(String trigger)` Finds the Option with the specified trigger
`int`	`getOptionCount(Option option)` Retrieves the number of times the specified Option appeared in this CommandLine
`int`	`getOptionCount(String trigger)` Retrieves the number of times the specified Option appeared in this CommandLine
`List`	`getOptions()` Retrieves a list of all Options found in this CommandLine
`Set`	`getOptionTriggers()` Retrieves a list of all Option triggers found in this CommandLine
`Set`	`getProperties()` Retrieves the set of all property names associated with the default property option
`Set`	`getProperties(Option option)` Retrieves the set of all property names associated with this option
`String`	`getProperty(Option option, String property)` Retrieves the value associated with the specified property
`String`	`getProperty(Option option, String property, String defaultValue)` Retrieves the value associated with the specified property
`String`	`getProperty(String property)` Retrieves the value associated with the specified property for the default property set
`Boolean`	`getSwitch(Option option)` Retrieves the Boolean value associated with the specified Switch
`Boolean`	`getSwitch(Option option, Boolean defaultValue)` Retrieves the Boolean value associated with the specified Switch
`Boolean`	`getSwitch(String trigger)` Retrieves the Boolean value associated with the specified Switch
`Boolean`	`getSwitch(String trigger, Boolean defaultValue)` Retrieves the Boolean value associated with the specified Switch
`Object`	`getValue(Option option)` Retrieves the single Argument value associated with the specified Option
`Object`	`getValue(Option option, Object defaultValue)` Retrieves the single Argument value associated with the specified Option
`Object`	`getValue(String trigger)` Retrieves the single Argument value associated with the specified Option
`Object`	`getValue(String trigger, Object defaultValue)` Retrieves the single Argument value associated with the specified Option
`List`	`getValues(Option option)` Retrieves the Argument values associated with the specified Option
`List`	`getValues(Option option, List defaultValues)` Retrieves the Argument values associated with the specified Option
`List`	`getValues(String trigger)` Retrieves the Argument values associated with the specified Option
`List`	`getValues(String trigger, List defaultValues)` Retrieves the Argument values associated with the specified Option
`boolean`	`hasOption(Option option)` Detects the presence of an option in this CommandLine.
`boolean`	`hasOption(String trigger)` Detects the presence of an option with the specified trigger in this CommandLine.

- Method Detail
  - hasOption
```
boolean hasOption(String trigger)
```
    Detects the presence of an option with the specified trigger in this CommandLine.
    
    Parameters:
    trigger - the trigger to search for
    
    Returns:
    true iff an option with this trigger is present
  - hasOption
```
boolean hasOption(Option option)
```
    Detects the presence of an option in this CommandLine.
    
    Parameters:
    option - the Option to search for
    
    Returns:
    true iff the option is present
  - getOption
```
Option getOption(String trigger)
```
    Finds the Option with the specified trigger
    
    Parameters:
    trigger - the name of the option to retrieve
    
    Returns:
    the Option matching the trigger or null if none exists
  - getValues
```
List getValues(String trigger)
```
    Retrieves the Argument values associated with the specified Option
    
    Parameters:
    trigger - a trigger used to lookup the Option
    
    Returns:
    a list of values or an empty List if none are found
  - getValues
```
List getValues(String trigger,
             List defaultValues)
```
    Retrieves the Argument values associated with the specified Option
    
    Parameters:
    trigger - a trigger used to lookup the Option
    defaultValues - the result to return if no values are found
    
    Returns:
    a list of values or defaultValues if none are found
  - getValues
```
List getValues(Option option)
```
    Retrieves the Argument values associated with the specified Option
    
    Parameters:
    option - the Option associated with the values
    
    Returns:
    a list of values or an empty List if none are found
  - getValues
```
List getValues(Option option,
             List defaultValues)
```
    Retrieves the Argument values associated with the specified Option
    
    Parameters:
    option - the Option associated with the values
    defaultValues - the result to return if no values are found
    
    Returns:
    a list of values or defaultValues if none are found
  - getValue
```
Object getValue(String trigger)
                throws IllegalStateException
```
    Retrieves the single Argument value associated with the specified Option
    
    Parameters:
    trigger - a trigger used to lookup the Option
    
    Returns:
    the matching value or null if none exists
    
    Throws:
    
    IllegalStateException - if more than one values are found
  - getValue
```
Object getValue(String trigger,
              Object defaultValue)
                throws IllegalStateException
```
    Retrieves the single Argument value associated with the specified Option
    
    Parameters:
    trigger - a trigger used to lookup the Option
    defaultValue - the result to use if no values are found
    
    Returns:
    the matching value or defaultValue if none exists
    
    Throws:
    
    IllegalStateException - if more than one values are found
  - getValue
```
Object getValue(Option option)
                throws IllegalStateException
```
    Retrieves the single Argument value associated with the specified Option
    
    Parameters:
    option - the Option associated with the value
    
    Returns:
    the matching value or null if none exists
    
    Throws:
    
    IllegalStateException - if more than one values are found
  - getValue
```
Object getValue(Option option,
              Object defaultValue)
                throws IllegalStateException
```
    Retrieves the single Argument value associated with the specified Option
    
    Parameters:
    option - the Option associated with the value
    defaultValue - the result to use if no values are found
    
    Returns:
    the matching value or defaultValue if none exists
    
    Throws:
    
    IllegalStateException - if more than one values are found
  - getSwitch
```
Boolean getSwitch(String trigger)
```
    Retrieves the Boolean value associated with the specified Switch
    
    Parameters:
    trigger - a trigger used to lookup the Option
    
    Returns:
    the Boolean associated with trigger or null if none exists
  - getSwitch
```
Boolean getSwitch(String trigger,
                Boolean defaultValue)
```
    Retrieves the Boolean value associated with the specified Switch
    
    Parameters:
    trigger - a trigger used to lookup the Option
    defaultValue - the Boolean to use if none match
    
    Returns:
    the Boolean associated with trigger or defaultValue if none exists
  - getSwitch
```
Boolean getSwitch(Option option)
```
    Retrieves the Boolean value associated with the specified Switch
    
    Parameters:
    option - the Option associated with the value
    
    Returns:
    the Boolean associated with option or null if none exists
  - getSwitch
```
Boolean getSwitch(Option option,
                Boolean defaultValue)
```
    Retrieves the Boolean value associated with the specified Switch
    
    Parameters:
    option - the Option associated with the value
    defaultValue - the Boolean to use if none match
    
    Returns:
    the Boolean associated with option or defaultValue if none exists
  - getProperty
```
String getProperty(String property)
```
    Retrieves the value associated with the specified property for the default property set
    
    Parameters:
    property - the property name to lookup
    
    Returns:
    the value of the property or null
  - getProperty
```
String getProperty(Option option,
                 String property)
```
    Retrieves the value associated with the specified property
    
    Parameters:
    option - the option i.e., -D
    property - the property name to lookup
    
    Returns:
    the value of the property or null
  - getProperty
```
String getProperty(Option option,
                 String property,
                 String defaultValue)
```
    Retrieves the value associated with the specified property
    
    Parameters:
    option - the option i.e., -D
    property - the property name to lookup
    defaultValue - the value to use if no other is found
    
    Returns:
    the value of the property or defaultValue
  - getProperties
```
Set getProperties(Option option)
```
    Retrieves the set of all property names associated with this option
    
    Parameters:
    option - the option i.e., -D
    
    Returns:
    a none null set of property names
  - getProperties
```
Set getProperties()
```
    Retrieves the set of all property names associated with the default property option
    
    Returns:
    a none null set of property names
  - getOptionCount
```
int getOptionCount(String trigger)
```
    Retrieves the number of times the specified Option appeared in this CommandLine
    
    Parameters:
    trigger - a trigger used to lookup the Option
    
    Returns:
    the number of occurrences of the option
  - getOptionCount
```
int getOptionCount(Option option)
```
    Retrieves the number of times the specified Option appeared in this CommandLine
    
    Parameters:
    option - the Option associated to check
    
    Returns:
    the number of occurrences of the option
  - getOptions
```
List getOptions()
```
    Retrieves a list of all Options found in this CommandLine
    
    Returns:
    a none null list of Options
  - getOptionTriggers
```
Set getOptionTriggers()
```
    Retrieves a list of all Option triggers found in this CommandLine
    
    Returns:
    a none null list of Option triggers

Interface CommandLine

Method Summary

Method Detail

hasOption

hasOption

getOption

getValues

getValues

getValues

getValues

getValue

getValue

getValue

getValue

getSwitch

getSwitch

getSwitch

getSwitch

getProperty

getProperty

getProperty

getProperties

getProperties

getOptionCount

getOptionCount

getOptions

getOptionTriggers