net.dpml.cli
public interface CommandLine
Version: @PROJECT-VERSION@
Method Summary | |
---|---|
Option | getOption(String trigger)
Finds the Option with the specified trigger
|
int | getOptionCount(String trigger)
Retrieves the number of times the specified Option appeared in this
CommandLine
|
int | getOptionCount(Option option)
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 this CommandLine
|
String | getProperty(String property)
Retrieves the value associated with the specified property
|
String | getProperty(String property, String defaultValue)
Retrieves the value associated with the specified property
|
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
|
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
|
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
|
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
|
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
|
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
|
boolean | hasOption(String trigger)
Detects the presence of an option with the specified trigger in this
CommandLine.
|
boolean | hasOption(Option option)
Detects the presence of an option in this CommandLine.
|
Parameters: trigger the name of the option to retrieve
Returns: the Option matching the trigger or null if none exists
Parameters: trigger a trigger used to lookup the Option
Returns: the number of occurrences of the option
Parameters: option the Option associated to check
Returns: the number of occurrences of the option
Returns: a none null list of Options
Returns: a none null list of Option triggers
Returns: a none null set of property names
Parameters: property the property name to lookup
Returns: the value of the property or null
Parameters: property the property name to lookup defaultValue the value to use if no other is found
Returns: the value of the property or defaultValue
Parameters: trigger a trigger used to lookup the Option
Returns: the Boolean associated with trigger or null if none exists
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
Parameters: option the Option associated with the value
Returns: the Boolean associated with option or null if none exists
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
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
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
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
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
Parameters: trigger a trigger used to lookup the Option
Returns: a list of values or an empty List if none are found
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
Parameters: option the Option associated with the values
Returns: a list of values or an empty List if none are found
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
Parameters: trigger the trigger to search for
Returns: true iff an option with this trigger is present
Parameters: option the Option to search for
Returns: true iff the option is present