net.dpml.cli.option
public class Switch extends ParentImpl
+d|-d
or --enable-x|--disable-x
.Version: @PROJECT-VERSION@
Field Summary | |
---|---|
static String | DEFAULT_DISABLED_PREFIX
The default prefix for disabled switches |
static String | DEFAULT_ENABLED_PREFIX
The default prefix for enabled switches |
static ResourceHelper | RESOURCES i18n |
Constructor Summary | |
---|---|
Switch(String enabledPrefix, String disabledPrefix, String preferredName, Set aliases, String description, boolean required, Argument argument, Group children, int id, Boolean switchDefault)
Creates a new Switch with the specified parameters |
Method Summary | |
---|---|
void | appendUsage(StringBuffer buffer, Set helpSettings, Comparator comp)
Appends usage information to the specified StringBuffer
|
void | defaults(WriteableCommandLine commandLine)
Adds defaults to a CommandLine.
|
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)
Processes the parent part of the Option. |
void | validate(WriteableCommandLine commandLine)
Checks that the supplied CommandLine is valid with respect to this
option.
|
Parameters: enabledPrefix the prefix used for enabled switches disabledPrefix the prefix used for disabled switches preferredName the preferred name of the switch aliases the aliases by which the Switch is known description a description of the Switch 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 switchDefault the switch default value
Throws: IllegalArgumentException if the preferredName or an alias isn't prefixed with enabledPrefix or disabledPrefix
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
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 to write results to arguments a ListIterator over argument strings positioned at the next argument to process
Throws: OptionException if an error occurs while processing
Parameters: commandLine the CommandLine to check.
Throws: OptionException if the CommandLine is not valid.