net.dpml.cli.commandline

Class PropertiesCommandLine

java.lang.Object

net.dpml.cli.commandline.CommandLineImpl

net.dpml.cli.commandline.PropertiesCommandLine

All Implemented Interfaces:

CommandLine

public class PropertiesCommandLine
extends CommandLineImpl

A CommandLine implementation using a java Properties instance, useful for constructing a complex DefaultingCommandLine Options are keyed from their property name and presence in the Properties instance is taken as presence in the CommandLine. Argument values are taken from the property value and are optionally separated using the separator char, defined at construction time. Switch values can be specified using a simple value of true or false; obviously this means that Switches with Arguments are not supported by this implementation.

Version:

@PROJECT-VERSION@

Author:

@PUBLISHER-NAME@

See Also:

Properties, DefaultingCommandLine, Option.getPreferredName()

Constructor Summary

Constructors

Constructor and Description
PropertiesCommandLine(Option root, java.util.Properties properties) Creates a new PropertiesCommandLine using the specified root Option, Properties instance.
PropertiesCommandLine(Option root, java.util.Properties properties, char separator) Creates a new PropertiesCommandLine using the specified root Option, Properties instance and value separator.

Method Summary

Modifier and Type	Method and Description
Option	getOption(java.lang.String trigger) Finds the Option with the specified trigger
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, java.lang.String defaultValue) Retrieves the value associated with the specified property
java.lang.Boolean	getSwitch(Option option, java.lang.Boolean defaultValue) Retrieves the Boolean value associated with the specified Switch
java.util.List	getValues(Option option, 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.

Methods inherited from class net.dpml.cli.commandline.CommandLineImpl

getOptionCount, getOptionCount, getProperty, getSwitch, getSwitch, getSwitch, getValue, getValue, getValue, getValue, getValues, getValues, getValues, hasOption

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesCommandLine

public PropertiesCommandLine(Option root,
                             java.util.Properties properties)

Creates a new PropertiesCommandLine using the specified root Option, Properties instance. The character 0 is used as the value separator.

Parameters:

root - the CommandLine's root Option

properties - the Properties instance to get values from

PropertiesCommandLine

public PropertiesCommandLine(Option root,
                             java.util.Properties properties,
                             char separator)

Creates a new PropertiesCommandLine using the specified root Option, Properties instance and value separator.

Parameters:

root - the CommandLine's root Option

properties - the Properties instance to get values from

separator - the character to split argument values

Method Detail

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

getOption

public 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

public 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

getSwitch

public 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

public 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

public java.util.Set getProperties()

Retrieves the set of all property names associated with this CommandLine

Returns:

a none null set of property names

getOptions

public java.util.List getOptions()

Retrieves a list of all Options found in this CommandLine

Returns:

a none null list of Options

getOptionTriggers

public java.util.Set getOptionTriggers()

Retrieves a list of all Option triggers found in this CommandLine

Returns:

a none null list of Option triggers