net.dpml.cli.option
public class DefaultOption extends ParentImpl
Version: @PROJECT-VERSION@
Field Summary | |
---|---|
static boolean | DEFAULT_BURST_ENABLED
The default value for the burstEnabled constructor parameter |
static String | DEFAULT_LONG_PREFIX
The default token used to prefix a long option |
static String | DEFAULT_SHORT_PREFIX
The default token used to prefix a short option |
Constructor Summary | |
---|---|
DefaultOption(String shortPrefix, String longPrefix, boolean burstEnabled, String preferredName, String description, Set aliases, Set burstAliases, boolean required, Argument argument, Group children, int id)
Creates a new DefaultOption
|
Method Summary | |
---|---|
void | appendUsage(StringBuffer buffer, Set helpSettings, Comparator comp)
Appends usage information to the specified StringBuffer
|
boolean | canProcess(WriteableCommandLine commandLine, String argument)
Indicates whether this Option will be able to process the particular
argument.
|
String | getPreferredName()
The preferred name of an option is used for generating help and usage
information.
|
Set | getPrefixes()
Identifies the argument prefixes that should be considered options. |
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: shortPrefix the prefix used for short options longPrefix the prefix used for long options burstEnabled should option bursting be enabled preferredName the preferred name for this Option, this should begin with either shortPrefix or longPrefix description a description of this Option aliases the alternative names for this Option burstAliases the aliases that can be burst required whether the Option is strictly required argument the Argument belonging to this Parent, or null children the Group children belonging to this Parent, ot null id the unique identifier for this Option
Throws: IllegalArgumentException if the preferredName or an alias isn't prefixed with shortPrefix or longPrefix
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 argument the argument to be tested
Returns: true if the argument can be processed by this Option
Returns: The preferred name of the option
Returns: The set of prefixes for this Option
Returns: The set of triggers for this Option
Parameters: commandLine the CommandLine object to store defaults in arguments the ListIterator over String arguments
Throws: OptionException if an error occurs
Parameters: commandLine the CommandLine to check.
Throws: OptionException if the CommandLine is not valid.