net.dpml.cli.option

Class ParentImpl

public abstract class ParentImpl extends OptionImpl implements Parent

A base implementation of Parent providing limited ground work for further Parent implementations.

Version: @PROJECT-VERSION@

Author: @PUBLISHER-NAME@

Constructor Summary
protected ParentImpl(Argument argument, Group children, String description, int id, boolean required)
Creation of a new ParaentImpl.
Method Summary
voidappendUsage(StringBuffer buffer, Set helpSettings, Comparator comp)
Appends usage information to the specified StringBuffer
booleancanProcess(WriteableCommandLine commandLine, String arg)
Indicates whether this Option will be able to process the particular argument.
voiddefaults(WriteableCommandLine commandLine)
Adds defaults to a CommandLine.
OptionfindOption(String trigger)
Recursively searches for an option with the supplied trigger.
ArgumentgetArgument()
Return the argument value if any.
GroupgetChildren()
Return any children.
StringgetDescription()
Returns a description of the option.
SetgetPrefixes()
Identifies the argument prefixes that should be considered options.
ListhelpLines(int depth, Set helpSettings, Comparator comp)
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.
voidprocess(WriteableCommandLine commandLine, ListIterator arguments)
Processes String arguments into a CommandLine.
voidvalidate(WriteableCommandLine commandLine)
Checks that the supplied CommandLine is valid with respect to this option.

Constructor Detail

ParentImpl

protected ParentImpl(Argument argument, Group children, String description, int id, boolean required)
Creation of a new ParaentImpl.

Parameters: argument an argument children the children description the description id the id required the required flag

Method Detail

appendUsage

public void appendUsage(StringBuffer buffer, Set helpSettings, Comparator comp)
Appends usage information to the specified StringBuffer

Parameters: buffer the buffer to append to helpSettings a set of display settings @see DisplaySetting comp a comparator used to sort the Options

canProcess

public boolean canProcess(WriteableCommandLine commandLine, String arg)
Indicates whether this Option will be able to process the particular argument.

Parameters: commandLine the CommandLine object to store defaults in arg the argument to be tested

Returns: true if the argument can be processed by this Option

defaults

public void defaults(WriteableCommandLine commandLine)
Adds defaults to a CommandLine. Any defaults for this option are applied as well as the defaults for any contained options

Parameters: commandLine the CommandLine object to store defaults in

findOption

public Option findOption(String trigger)
Recursively searches for an option with the supplied trigger.

Parameters: trigger the trigger to search for.

Returns: the matching option or null.

getArgument

public Argument getArgument()
Return the argument value if any.

Returns: Returns the argument.

getChildren

public Group getChildren()
Return any children.

Returns: Returns the children.

getDescription

public String getDescription()
Returns a description of the option. This string is used to build help messages as in the HelpFormatter.

Returns: a description of the option.

See Also: HelpFormatter

getPrefixes

public Set getPrefixes()
Identifies the argument prefixes that should be considered options. This is used to identify whether a given string looks like an option or an argument value. Typically an option would return the set [--,-] while switches might offer [-,+]. The returned Set must not be null.

Returns: The set of prefixes for this Option

helpLines

public List helpLines(int depth, Set helpSettings, Comparator comp)
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.

Parameters: depth the initial indent depth helpSettings the HelpSettings that should be applied comp a comparator used to sort options when applicable.

Returns: a List of HelpLineImpl objects

See Also: HelpLine HelpFormatter

process

public void process(WriteableCommandLine commandLine, ListIterator arguments)
Processes String arguments into a CommandLine. The iterator will initially point at the first argument to be processed and at the end of the method should point to the first argument not processed. This method MUST process at least one argument from the ListIterator.

Parameters: commandLine the CommandLine object to store results in arguments the arguments to process

Throws: OptionException if any problems occur

validate

public void validate(WriteableCommandLine commandLine)
Checks that the supplied CommandLine is valid with respect to this option.

Parameters: commandLine the CommandLine to check.

Throws: OptionException if the CommandLine is not valid.