net.dpml.cli.commandline
Class DefaultingCommandLine
- CommandLine
Manages a queue of default CommandLines. This CommandLine implementation is
backed by a queue of CommandLine instances which are queried in turn until a
suitable result is found.
CommandLine instances can either be added to the back of the queue or can be
pushed in at a specific position.
void | appendCommandLine(CommandLine commandLine) - Adds a CommandLine instance to the back of the queue.
|
Iterator | commandLines() - Builds an iterator over the build in CommandLines.
|
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.
|
void | insertCommandLine(int index, CommandLine commandLine) - Adds a CommandLine instance to a specified position in the queue.
|
getOptionCount , getOptionCount , getProperty , getSwitch , getSwitch , getSwitch , getValue , getValue , getValue , getValue , getValues , getValues , getValues , hasOption |
appendCommandLine
public void appendCommandLine(CommandLine commandLine)
Adds a CommandLine instance to the back of the queue. The supplied
CommandLine will be used as defaults when all other CommandLines produce
no result
commandLine
- the default values to use if all CommandLines
commandLines
public Iterator commandLines()
Builds an iterator over the build in CommandLines.
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
insertCommandLine
public void insertCommandLine(int index,
CommandLine commandLine)
Adds a CommandLine instance to a specified position in the queue.
index
- ths position at which to insertcommandLine
- the CommandLine to insert