net.dpml.cli

Interface CommandLine

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.

Version:

@PROJECT-VERSION@

Author:

@PUBLISHER-NAME@

Method Summary

Modifier and Type	Method and Description
Option	getOption(java.lang.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(java.lang.String trigger) Retrieves the number of times the specified Option appeared in this CommandLine
java.util.List	getOptions() Retrieves a list of all Options found in this CommandLine
java.util.Set	getOptionTriggers() Retrieves a list of all Option triggers found in this CommandLine
java.util.Set	getProperties() Retrieves the set of all property names associated with this CommandLine
java.lang.String	getProperty(java.lang.String property) Retrieves the value associated with the specified property
java.lang.String	getProperty(java.lang.String property, java.lang.String defaultValue) Retrieves the value associated with the specified property
java.lang.Boolean	getSwitch(Option option) Retrieves the Boolean value associated with the specified Switch
java.lang.Boolean	getSwitch(Option option, java.lang.Boolean defaultValue) Retrieves the Boolean value associated with the specified Switch
java.lang.Boolean	getSwitch(java.lang.String trigger) Retrieves the Boolean value associated with the specified Switch
java.lang.Boolean	getSwitch(java.lang.String trigger, java.lang.Boolean defaultValue) Retrieves the Boolean value associated with the specified Switch
java.lang.Object	getValue(Option option) Retrieves the single Argument value associated with the specified Option
java.lang.Object	getValue(Option option, java.lang.Object defaultValue) Retrieves the single Argument value associated with the specified Option
java.lang.Object	getValue(java.lang.String trigger) Retrieves the single Argument value associated with the specified Option
java.lang.Object	getValue(java.lang.String trigger, java.lang.Object defaultValue) Retrieves the single Argument value associated with the specified Option
java.util.List	getValues(Option option) Retrieves the Argument values associated with the specified Option
java.util.List	getValues(Option option, java.util.List defaultValues) Retrieves the Argument values associated with the specified Option
java.util.List	getValues(java.lang.String trigger) Retrieves the Argument values associated with the specified Option
java.util.List	getValues(java.lang.String trigger, java.util.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(java.lang.String trigger) Detects the presence of an option with the specified trigger in this CommandLine.

Method Detail

hasOption

boolean hasOption(java.lang.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(java.lang.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

java.util.List getValues(java.lang.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

java.util.List getValues(java.lang.String trigger,
                         java.util.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

java.util.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

java.util.List getValues(Option option,
                         java.util.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

java.lang.Object getValue(java.lang.String trigger)
                   throws java.lang.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:

java.lang.IllegalStateException - if more than one values are found

getValue

java.lang.Object getValue(java.lang.String trigger,
                          java.lang.Object defaultValue)
                   throws java.lang.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:

java.lang.IllegalStateException - if more than one values are found

getValue

java.lang.Object getValue(Option option)
                   throws java.lang.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:

java.lang.IllegalStateException - if more than one values are found

getValue

java.lang.Object getValue(Option option,
                          java.lang.Object defaultValue)
                   throws java.lang.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:

java.lang.IllegalStateException - if more than one values are found

getSwitch

java.lang.Boolean getSwitch(java.lang.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

java.lang.Boolean getSwitch(java.lang.String trigger,
                            java.lang.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

java.lang.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

java.lang.Boolean getSwitch(Option option,
                            java.lang.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

java.lang.String getProperty(java.lang.String property)

Retrieves the value associated with the specified property

Parameters:

property - the property name to lookup

Returns:

the value of the property or null

getProperty

java.lang.String getProperty(java.lang.String property,
                             java.lang.String defaultValue)

Retrieves the value associated with the specified property

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

getProperties

java.util.Set getProperties()

Retrieves the set of all property names associated with this CommandLine

Returns:

a none null set of property names

getOptionCount

int getOptionCount(java.lang.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

java.util.List getOptions()

Retrieves a list of all Options found in this CommandLine

Returns:

a none null list of Options

getOptionTriggers

java.util.Set getOptionTriggers()

Retrieves a list of all Option triggers found in this CommandLine

Returns:

a none null list of Option triggers