net.dpml.cli.commandline
Class CommandLineImpl

java.lang.Object
  net.dpml.cli.commandline.CommandLineImpl

All Implemented Interfaces:

CommandLine

Direct Known 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@

Constructor Summary

CommandLineImpl()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.dpml.cli.CommandLine

getOption, getOptions, getOptionTriggers, getProperties, getProperty, getSwitch, getValues, hasOption

Constructor Detail

CommandLineImpl

public CommandLineImpl()

Method Detail

hasOption

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

getValues

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

getValue

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

Throws:

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

getValue

public final 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

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

Throws:

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

getValue

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

Throws:

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

getValue

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

Throws:

java.lang.IllegalStateException - if more than one value is found

getSwitch

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

getProperty

public final java.lang.String getProperty(java.lang.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

getOptionCount

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