net.dpml.cli.commandline

Class DefaultingCommandLine

java.lang.Object

net.dpml.cli.commandline.CommandLineImpl

net.dpml.cli.commandline.DefaultingCommandLine

All Implemented Interfaces:

CommandLine

public class DefaultingCommandLine
extends CommandLineImpl

Manages a queue of default CommandLines. This CommandLine implementation is backed by a queue of CommandLine instances which are queried in turn until a suitable result is found. CommandLine instances can either be added to the back of the queue or can be pushed in at a specific position.

Version:

@PROJECT-VERSION@

Author:

@PUBLISHER-NAME@

See Also:

appendCommandLine(CommandLine), insertCommandLine(int, CommandLine)

Constructor Summary

Constructors

Constructor and Description
DefaultingCommandLine()

Method Summary

Modifier and Type	Method and Description
void	appendCommandLine(CommandLine commandLine) Adds a CommandLine instance to the back of the queue.
java.util.Iterator	commandLines() Builds an iterator over the build in CommandLines.
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.
void	insertCommandLine(int index, CommandLine commandLine) Adds a CommandLine instance to a specified position in the queue.

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

DefaultingCommandLine

public DefaultingCommandLine()

Method Detail

appendCommandLine

public void appendCommandLine(CommandLine commandLine)

Adds a CommandLine instance to the back of the queue. The supplied CommandLine will be used as defaults when all other CommandLines produce no result

Parameters:

commandLine - the default values to use if all CommandLines

insertCommandLine

public void insertCommandLine(int index,
                              CommandLine commandLine)

Adds a CommandLine instance to a specified position in the queue.

Parameters:

index - ths position at which to insert

commandLine - the CommandLine to insert

commandLines

public java.util.Iterator commandLines()

Builds an iterator over the build in CommandLines.

Returns:

an unmodifiable iterator

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

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

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

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