org.apache.commons.cli2.commandline
Class PropertiesCommandLine

java.lang.Object
  extended by org.apache.commons.cli2.commandline.CommandLineImpl
      extended by org.apache.commons.cli2.commandline.PropertiesCommandLine
All Implemented Interfaces:
CommandLine

public class PropertiesCommandLine
extends CommandLineImpl

A CommandLine implementation using a java Properties instance, useful for constructing a complex DefaultingCommandLine Options are keyed from their property name and presence in the Properties instance is taken as presence in the CommandLine. Argument values are taken from the property value and are optionally separated using the separator char, defined at construction time. Switch values can be specified using a simple value of true or false; obviously this means that Switches with Arguments are not supported by this implementation.

See Also:
Properties, DefaultingCommandLine, Option.getPreferredName()

Constructor Summary
PropertiesCommandLine(Option root, Properties properties)
          Creates a new PropertiesCommandLine using the specified root Option, Properties instance.
PropertiesCommandLine(Option root, Properties properties, char separator)
          Creates a new PropertiesCommandLine using the specified root Option, Properties instance and value separator.
 
Method Summary
 Option getOption(String trigger)
          Finds the Option with the specified trigger
 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, 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, Boolean defaultValue)
          Retrieves the Boolean value associated with the specified Switch
 List getValues(Option option, List defaultValues)
          Retrieves the Argument values associated with the specified Option
 boolean hasOption(Option option)
          Detects the presence of an option in this CommandLine.
 
Methods inherited from class org.apache.commons.cli2.commandline.CommandLineImpl
getOptionCount, getOptionCount, getProperty, getSwitch, getSwitch, getSwitch, getValue, getValue, getValue, getValue, getValues, getValues, getValues, hasOption
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertiesCommandLine

public PropertiesCommandLine(Option root,
                             Properties properties)
Creates a new PropertiesCommandLine using the specified root Option, Properties instance. The character 0 is used as the value separator.

Parameters:
root - the CommandLine's root Option
properties - the Properties instance to get values from

PropertiesCommandLine

public PropertiesCommandLine(Option root,
                             Properties properties,
                             char separator)
Creates a new PropertiesCommandLine using the specified root Option, Properties instance and value separator.

Parameters:
root - the CommandLine's root Option
properties - the Properties instance to get values from
separator - the character to split argument values
Method Detail

hasOption

public boolean hasOption(Option option)
Description copied from interface: CommandLine
Detects the presence of an option in this CommandLine.

Parameters:
option - the Option to search for
Returns:
true iff the option is present

getOption

public Option getOption(String trigger)
Description copied from interface: CommandLine
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

public List getValues(Option option,
                      List defaultValues)
Description copied from interface: CommandLine
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

getSwitch

public Boolean getSwitch(Option option,
                         Boolean defaultValue)
Description copied from interface: CommandLine
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

public String getProperty(String property)
Description copied from interface: CommandLine
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

public String getProperty(Option option,
                          String property,
                          String defaultValue)
Description copied from interface: CommandLine
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

public Set getProperties(Option option)
Description copied from interface: CommandLine
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

public Set getProperties()
Description copied from interface: CommandLine
Retrieves the set of all property names associated with the default property option

Returns:
a none null set of property names

getOptions

public List getOptions()
Description copied from interface: CommandLine
Retrieves a list of all Options found in this CommandLine

Returns:
a none null list of Options

getOptionTriggers

public Set getOptionTriggers()
Description copied from interface: CommandLine
Retrieves a list of all Option triggers found in this CommandLine

Returns:
a none null list of Option triggers


Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.