net.dpml.cli.commandline

Class CommandLineImpl

Implemented Interfaces:
CommandLine
Known Direct Subclasses:
DefaultingCommandLine, PreferencesCommandLine, PropertiesCommandLine, WriteableCommandLineImpl

public abstract class CommandLineImpl
extends java.lang.Object
implements 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

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
String
getProperty(String property)
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
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
boolean
hasOption(String trigger)
Detects the presence of an option with the specified trigger in this CommandLine.

Method Details

getOptionCount

public final int getOptionCount(String trigger)
Retrieves the number of times the specified Option appeared in this CommandLine
Specified by:
getOptionCount in interface CommandLine
Parameters:
trigger - a trigger used to lookup the Option
Returns:
the number of occurrences of the option

getOptionCount

public final int getOptionCount(Option option)
Retrieves the number of times the specified Option appeared in this CommandLine
Specified by:
getOptionCount in interface CommandLine
Parameters:
option - the Option associated to check
Returns:
the number of occurrences of the option

getProperty

public final String getProperty(String property)
Retrieves the value associated with the specified property
Specified by:
getProperty in interface CommandLine
Parameters:
property - the property name to lookup
Returns:
the value of the property or null

getSwitch

public final Boolean getSwitch(String trigger)
Retrieves the Boolean value associated with the specified Switch
Specified by:
getSwitch in interface CommandLine
Parameters:
trigger - a trigger used to lookup the Option
Returns:
the Boolean associated with trigger or null if none exists

getSwitch

public final Boolean getSwitch(String trigger,
                               Boolean defaultValue)
Retrieves the Boolean value associated with the specified Switch
Specified by:
getSwitch in interface CommandLine
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

public final Boolean getSwitch(Option option)
Retrieves the Boolean value associated with the specified Switch
Specified by:
getSwitch in interface CommandLine
Parameters:
option - the Option associated with the value
Returns:
the Boolean associated with option or null if none exists

getValue

public final Object getValue(String trigger)
            throws IllegalStateException
Retrieves the single Argument value associated with the specified Option
Specified by:
getValue in interface CommandLine
Parameters:
trigger - a trigger used to lookup the Option
Returns:
the matching value or null if none exists

getValue

public final Object getValue(String trigger,
                             Object defaultValue)
            throws IllegalStateException
Retrieves the single Argument value associated with the specified Option
Specified by:
getValue in interface CommandLine
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

getValue

public final Object getValue(Option option)
            throws IllegalStateException
Retrieves the single Argument value associated with the specified Option
Specified by:
getValue in interface CommandLine
Parameters:
option - the Option associated with the value
Returns:
the matching value or null if none exists

getValue

public final Object getValue(Option option,
                             Object defaultValue)
            throws IllegalStateException
Retrieves the single Argument value associated with the specified Option
Specified by:
getValue in interface CommandLine
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

getValues

public final List getValues(String trigger)
Retrieves the Argument values associated with the specified Option
Specified by:
getValues in interface CommandLine
Parameters:
trigger - a trigger used to lookup the Option
Returns:
a list of values or an empty List if none are found

getValues

public final List getValues(String trigger,
                            List defaultValues)
Retrieves the Argument values associated with the specified Option
Specified by:
getValues in interface CommandLine
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

public final List getValues(Option option)
Retrieves the Argument values associated with the specified Option
Specified by:
getValues in interface CommandLine
Parameters:
option - the Option associated with the values
Returns:
a list of values or an empty List if none are found

hasOption

public final boolean hasOption(String trigger)
Detects the presence of an option with the specified trigger in this CommandLine.
Specified by:
hasOption in interface CommandLine
Parameters:
trigger - the trigger to search for
Returns:
true iff an option with this trigger is present