net.dpml.cli.commandline
Class PreferencesCommandLine
- CommandLine
A CommandLine implementation using the Preferences API, useful when
constructing a complex DefaultingCommandLine
This implementation uses the children of a single preference node to populate
the CommandLine. Options are keyed from their preferred name and presence in
the Preferences object is taken as presence in the CommandLine. Argument
values are taken from the Preference 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.
PreferencesCommandLine(Option root, Preferences preferences) - Creates a new PreferencesCommandLine using the specified root Option and
Preferences node.
|
PreferencesCommandLine(Option root, Preferences preferences, char separator) - Creates a new PreferencesCommandLine using the specified root Option,
Preferences node and value separator.
|
Option | getOption(String trigger) - Finds the Option with the specified trigger
|
Set | getOptionTriggers() - Retrieves a list of all Option triggers found in this CommandLine
|
List | getOptions() - Retrieves a list of all Options found in this CommandLine
|
Set | getProperties() - Retrieves the set of all property names associated with this CommandLine
|
String | getProperty(String property, String defaultValue) - Retrieves the value associated with the specified property
|
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.
|
getOptionCount , getOptionCount , getProperty , getSwitch , getSwitch , getSwitch , getValue , getValue , getValue , getValue , getValues , getValues , getValues , hasOption |
PreferencesCommandLine
public PreferencesCommandLine(Option root,
Preferences preferences)
Creates a new PreferencesCommandLine using the specified root Option and
Preferences node. Argument values will be separated using the char 0.
root
- the CommandLine's root Optionpreferences
- the Preferences node to get values from
PreferencesCommandLine
public PreferencesCommandLine(Option root,
Preferences preferences,
char separator)
Creates a new PreferencesCommandLine using the specified root Option,
Preferences node and value separator.
root
- the CommandLine's root Optionpreferences
- the Preferences node to get values fromseparator
- the character to split argument values
getOption
public Option getOption(String trigger)
Finds the Option with the specified trigger
- getOption in interface CommandLine
trigger
- the name of the option to retrieve
- the Option matching the trigger or null if none exists
getOptions
public List getOptions()
Retrieves a list of all Options found in this CommandLine
- getOptions in interface CommandLine
- a none null list of Options
getProperty
public String getProperty(String property,
String defaultValue)
Retrieves the value associated with the specified property
- getProperty in interface CommandLine
property
- the property name to lookupdefaultValue
- the value to use if no other is found
- the value of the property or defaultValue
getSwitch
public Boolean getSwitch(Option option,
Boolean defaultValue)
Retrieves the Boolean value associated with the specified Switch
- getSwitch in interface CommandLine
option
- the Option associated with the valuedefaultValue
- the Boolean to use if none match
- the Boolean associated with option or defaultValue if none exists
getValues
public List getValues(Option option,
List defaultValues)
Retrieves the Argument values associated with the specified Option
- getValues in interface CommandLine
option
- the Option associated with the valuesdefaultValues
- the result to return if no values are found
- a list of values or defaultValues if none are found
hasOption
public boolean hasOption(Option option)
Detects the presence of an option in this CommandLine.
- hasOption in interface CommandLine
option
- the Option to search for
- true iff the option is present