net.dpml.cli.option
public abstract class ParentImpl extends OptionImpl implements Parent
Version: @PROJECT-VERSION@
Constructor Summary | |
---|---|
protected | ParentImpl(Argument argument, Group children, String description, int id, boolean required)
Creation of a new ParaentImpl. |
Method Summary | |
---|---|
void | appendUsage(StringBuffer buffer, Set helpSettings, Comparator comp)
Appends usage information to the specified StringBuffer
|
boolean | canProcess(WriteableCommandLine commandLine, String arg)
Indicates whether this Option will be able to process the particular
argument.
|
void | defaults(WriteableCommandLine commandLine)
Adds defaults to a CommandLine.
|
Option | findOption(String trigger)
Recursively searches for an option with the supplied trigger.
|
Argument | getArgument()
Return the argument value if any. |
Group | getChildren()
Return any children. |
String | getDescription()
Returns a description of the option. |
Set | getPrefixes()
Identifies the argument prefixes that should be considered options. |
List | helpLines(int depth, Set helpSettings, Comparator comp)
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.
|
void | process(WriteableCommandLine commandLine, ListIterator arguments)
Processes String arguments into a CommandLine.
|
void | validate(WriteableCommandLine commandLine)
Checks that the supplied CommandLine is valid with respect to this
option.
|
Parameters: argument an argument children the children description the description id the id required the required flag
Parameters: buffer the buffer to append to helpSettings a set of display settings @see DisplaySetting comp a comparator used to sort the Options
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
Parameters: commandLine the CommandLine object to store defaults in
Parameters: trigger the trigger to search for.
Returns: the matching option or null.
Returns: Returns the argument.
Returns: Returns the children.
Returns: a description of the option.
See Also: HelpFormatter
Returns: The set of prefixes for this Option
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
Parameters: commandLine the CommandLine object to store results in arguments the arguments to process
Throws: OptionException if any problems occur
Parameters: commandLine the CommandLine to check.
Throws: OptionException if the CommandLine is not valid.