net.dpml.cli.option
Class Switch
- Option, Parent
A Parent implementation representing normal switch options.
For example: +d|-d
or --enable-x|--disable-x
.
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
|
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.
|
appendUsage , canProcess , defaults , findOption , getArgument , getChildren , getDescription , getPrefixes , helpLines , process , validate |
DEFAULT_ENABLED_PREFIX
public static final String DEFAULT_ENABLED_PREFIX
The default prefix for enabled switches
Switch
public Switch(String enabledPrefix,
String disabledPrefix,
String preferredName,
Set aliases,
String description,
boolean required,
Argument argument,
Group children,
int id,
Boolean switchDefault)
throws IllegalArgumentException
Creates a new Switch with the specified parameters
enabledPrefix
- the prefix used for enabled switchesdisabledPrefix
- the prefix used for disabled switchespreferredName
- the preferred name of the switchaliases
- the aliases by which the Switch is knowndescription
- a description of the Switchrequired
- whether the Option is strictly requiredargument
- the Argument belonging to this Parent, or nullchildren
- the Group children belonging to this Parent, ot nullid
- the unique identifier for this OptionswitchDefault
- the switch default value
appendUsage
public void appendUsage(StringBuffer buffer,
Set helpSettings,
Comparator comp)
Appends usage information to the specified StringBuffer
- appendUsage in interface Option
- appendUsage in interface ParentImpl
buffer
- the buffer to append tohelpSettings
- a set of display settings @see DisplaySettingcomp
- a comparator used to sort the Options
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
- defaults in interface Option
- defaults in interface ParentImpl
commandLine
- the CommandLine object to store defaults in
getPreferredName
public String getPreferredName()
The preferred name of an option is used for generating help and usage
information.
- getPreferredName in interface Option
- The preferred name of the option
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.
- getPrefixes in interface Option
- getPrefixes in interface ParentImpl
- The set of prefixes for this Option
getTriggers
public Set getTriggers()
Identifies the argument prefixes that should trigger this option. This
is used to decide which of many Options should be tried when processing
a given argument string.
The returned Set must not be null.
- getTriggers in interface Option
- The set of triggers for this Option
processParent
public void processParent(WriteableCommandLine commandLine,
ListIterator arguments)
throws OptionException
Processes the parent part of the Option. The combination of parent,
argument and children is handled by the process method.
- processParent in interface Parent
commandLine
- the CommandLine to write results toarguments
- a ListIterator over argument strings positioned at the next
argument to process