net.dpml.cli.option
Class PropertyOption
- Option
Handles the java style "-Dprop=value" opions
PropertyOption() - Creates a new PropertyOption using the default settings of a "-D" trigger
and an id of 'D'
|
PropertyOption(String optionString, String description, int id) - Creates a new PropertyOption using the specified parameters
|
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 | getDescription() - Returns a description of the option.
|
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.
|
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.
|
DEFAULT_DESCRIPTION
public static final String DEFAULT_DESCRIPTION
The default property option description.
PropertyOption
public PropertyOption()
Creates a new PropertyOption using the default settings of a "-D" trigger
and an id of 'D'
PropertyOption
public PropertyOption(String optionString,
String description,
int id)
Creates a new PropertyOption using the specified parameters
optionString
- the trigger for the Optiondescription
- the description of the Optionid
- the id of the Option
appendUsage
public void appendUsage(StringBuffer buffer,
Set helpSettings,
Comparator comp)
Appends usage information to the specified StringBuffer
- appendUsage in interface Option
buffer
- the buffer to append tohelpSettings
- a set of display settings @see DisplaySettingcomp
- a comparator used to sort the Options
canProcess
public boolean canProcess(WriteableCommandLine commandLine,
String argument)
Indicates whether this Option will be able to process the particular
argument.
- canProcess in interface Option
commandLine
- the CommandLine object to store defaults inargument
- the argument to be tested
- true if the argument can be processed by this Option
getDescription
public String getDescription()
Returns a description of the option. This string is used to build help
messages as in the HelpFormatter.
- getDescription in interface Option
- a description of the option.
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
- 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
helpLines
public List helpLines(int depth,
Set helpSettings,
Comparator comp)
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.
- helpLines in interface Option
depth
- the initial indent depthhelpSettings
- the HelpSettings that should be appliedcomp
- a comparator used to sort options when applicable.
- a List of HelpLineImpl objects
process
public void process(WriteableCommandLine commandLine,
ListIterator arguments)
throws OptionException
Processes String arguments into a CommandLine.
The iterator will initially point at the first argument to be processed
and at the end of the method should point to the first argument not
processed. This method MUST process at least one argument from the
ListIterator.
- process in interface Option
commandLine
- the CommandLine object to store results inarguments
- the arguments to process