net.dpml.cli.option
public class Command extends ParentImpl
Version: @PROJECT-VERSION@
Constructor Summary | |
---|---|
Command(String preferredName, String description, Set aliases, boolean required, Argument argument, Group children, int id)
Creates a new Command instance.
|
Method Summary | |
---|---|
void | appendUsage(StringBuffer buffer, Set helpSettings, Comparator comp)
Appends usage information to the specified StringBuffer
|
String | getPreferredName()
The preferred name of an option is used for generating help and usage
information.
|
Set | getTriggers()
Identifies the argument prefixes that should trigger this option. |
void | processParent(WriteableCommandLine commandLine, ListIterator arguments)
Process the parent. |
void | validate(WriteableCommandLine commandLine)
Checks that the supplied CommandLine is valid with respect to this
option.
|
Parameters: preferredName the name normally used to refer to the Command description a description of the Command aliases alternative names for the Command required true if the Command is required argument an Argument that the command takes children the Group of child options for this Command id a unique id for the Command
See Also: ParentImpl
Parameters: buffer the buffer to append to helpSettings a set of display settings @see DisplaySetting comp a comparator used to sort the Options
Returns: The preferred name of the option
Returns: The set of triggers for this Option
Parameters: commandLine the commandline arguments an iterator of arguments
Throws: OptionException if an error occurs
Parameters: commandLine the CommandLine to check.
Throws: OptionException if the CommandLine is not valid.