net.dpml.cli.commandline

Class WriteableCommandLineImpl

public class WriteableCommandLineImpl extends CommandLineImpl implements WriteableCommandLine

A WriteableCommandLine implementation allowing Options to write their processed information to a CommandLine.

Version: @PROJECT-VERSION@

Author: @PUBLISHER-NAME@

Constructor Summary
WriteableCommandLineImpl(Option rootOption, List arguments)
Creates a new WriteableCommandLineImpl rooted on the specified Option, to hold the parsed arguments.
Method Summary
voidaddOption(Option option)
Add an option.
voidaddProperty(String property, String value)
Add a property to the commandline.
voidaddSwitch(Option option, boolean value)
Add a switch.
voidaddValue(Option option, Object value)
Add an option.
ListgetNormalised()
Return the normalized collection.
OptiongetOption(String trigger)
Finds the Option with the specified trigger
ListgetOptions()
Retrieves a list of all Options found in this CommandLine
SetgetOptionTriggers()
Retrieves a list of all Option triggers found in this CommandLine
SetgetProperties()
Retrieves the set of all property names associated with this CommandLine
StringgetProperty(String property, String defaultValue)
Retrieves the value associated with the specified property
BooleangetSwitch(Option option, Boolean defaultValue)
Retrieves the Boolean value associated with the specified Switch
ListgetValues(Option option, List defaultValues)
Retrieves the Argument values associated with the specified Option
booleanhasOption(Option option)
Detects the presence of an option in this CommandLine.
booleanlooksLikeOption(String trigger)
Return true if the trigger argument looks like an option.
voidsetDefaultSwitch(Option option, Boolean defaultSwitch)
Set default switch.
voidsetDefaultValues(Option option, List defaults)
Set default values.
StringtoString()
Return this commandline as a string.

Constructor Detail

WriteableCommandLineImpl

public WriteableCommandLineImpl(Option rootOption, List arguments)
Creates a new WriteableCommandLineImpl rooted on the specified Option, to hold the parsed arguments.

Parameters: rootOption the CommandLine's root Option arguments the arguments this CommandLine represents

Method Detail

addOption

public void addOption(Option option)
Add an option.

Parameters: option the option to add

addProperty

public void addProperty(String property, String value)
Add a property to the commandline.

Parameters: property the property name value the property value

addSwitch

public void addSwitch(Option option, boolean value)
Add a switch.

Parameters: option the option to add value the option value

addValue

public void addValue(Option option, Object value)
Add an option.

Parameters: option the option to add value the option value

getNormalised

public List getNormalised()
Return the normalized collection.

Returns: the moprmalized collection

getOption

public Option getOption(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

getOptions

public List getOptions()
Retrieves a list of all Options found in this CommandLine

Returns: a none null list of Options

getOptionTriggers

public Set getOptionTriggers()
Retrieves a list of all Option triggers found in this CommandLine

Returns: a none null list of Option triggers

getProperties

public Set getProperties()
Retrieves the set of all property names associated with this CommandLine

Returns: a none null set of property names

getProperty

public String getProperty(String property, 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

getSwitch

public Boolean getSwitch(Option option, 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

getValues

public List getValues(Option option, 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

hasOption

public 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

looksLikeOption

public boolean looksLikeOption(String trigger)
Return true if the trigger argument looks like an option.

Parameters: trigger the trigger to evaluate

Returns: true if the trigger looks like an option

setDefaultSwitch

public void setDefaultSwitch(Option option, Boolean defaultSwitch)
Set default switch.

Parameters: option the option defaultSwitch the default switch state

setDefaultValues

public void setDefaultValues(Option option, List defaults)
Set default values.

Parameters: option the option defaults a list of defaults

toString

public String toString()
Return this commandline as a string.

Returns: the string representation