net.dpml.cli
Interface Option
- Argument, Group, Parent
- ArgumentImpl, Command, DefaultOption, GroupImpl, OptionImpl, ParentImpl, PropertyOption, SourceDestArgument, Switch
The super type of all options representing a particular element of the
command line interface.
void | appendUsage(StringBuffer buffer, Set helpSettings, Comparator comp) - Appends usage information to the specified StringBuffer
|
boolean | canProcess(WriteableCommandLine commandLine, ListIterator arguments) - Indicates whether this Option will be able to process the particular
argument.
|
boolean | canProcess(WriteableCommandLine commandLine, String argument) - Indicates whether this Option will be able to process the particular
argument.
|
void | defaults(WriteableCommandLine commandLine) - Adds defaults to a CommandLine.
|
Option | findOption(String trigger) - Recursively searches for an option with the supplied trigger.
|
String | getDescription() - Returns a description of the option.
|
int | getId() - Returns the id 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.
|
boolean | isRequired() - Indicates whether this option is required to be present.
|
void | process(WriteableCommandLine commandLine, ListIterator args) - Processes String arguments into a CommandLine.
|
void | validate(WriteableCommandLine commandLine) - Checks that the supplied CommandLine is valid with respect to this
option.
|
appendUsage
public void appendUsage(StringBuffer buffer,
Set helpSettings,
Comparator comp)
Appends usage information to the specified StringBuffer
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,
ListIterator arguments)
Indicates whether this Option will be able to process the particular
argument. The ListIterator must be restored to the initial state before
returning the boolean.
commandLine
- the CommandLine object to store defaults inarguments
- the ListIterator over String arguments
- true if the argument can be processed by this Option
canProcess
public boolean canProcess(WriteableCommandLine commandLine,
String argument)
Indicates whether this Option will be able to process the particular
argument.
commandLine
- the CommandLine object to store defaults inargument
- the argument to be tested
- true if the argument can be processed by this Option
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
commandLine
- the CommandLine object to store defaults in
findOption
public Option findOption(String trigger)
Recursively searches for an option with the supplied trigger.
trigger
- the trigger to search for.
- the matching option or null.
getDescription
public String getDescription()
Returns a description of the option. This string is used to build help
messages as in the HelpFormatter.
- a description of the option.
getId
public int getId()
Returns the id of the option. This can be used in a loop and switch
construct:
for(Option o : cmd.getOptions()){
switch(o.getId()){
case POTENTIAL_OPTION:
...
}
}
The returned value is not guarenteed to be unique.
getPreferredName
public String getPreferredName()
The preferred name of an option is used for generating help and usage
information.
- 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.
- 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.
- 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.
depth
- the initial indent depthhelpSettings
- the HelpSettings that should be appliedcomp
- a comparator used to sort options when applicable.
- a List of HelpLineImpl objects
isRequired
public boolean isRequired()
Indicates whether this option is required to be present.
- true if the CommandLine will be invalid without this Option
process
public void process(WriteableCommandLine commandLine,
ListIterator args)
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.
commandLine
- the CommandLine object to store results inargs
- the arguments to process