net.dpml.cli
public interface Option
Version: @PROJECT-VERSION@
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.
|
boolean | canProcess(WriteableCommandLine commandLine, ListIterator arguments)
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.
|
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
Parameters: commandLine the CommandLine object to store defaults in arguments the ListIterator over String arguments
Returns: true if the argument can be processed by this Option
See Also: canProcess
Parameters: commandLine the CommandLine object to store defaults in
Parameters: trigger the trigger to search for.
Returns: the matching option or null.
Returns: a description of the option.
See Also: HelpFormatter
for(Option o : cmd.getOptions()){
switch(o.getId()){
case POTENTIAL_OPTION:
...
}
}
The returned value is not guarenteed to be unique.
Returns: the id of the 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: depth the initial indent depth helpSettings the HelpSettings that should be applied comp a comparator used to sort options when applicable.
Returns: a List of HelpLineImpl objects
See Also: HelpLine HelpFormatter
Returns: true if the CommandLine will be invalid without this Option
Parameters: commandLine the CommandLine object to store results in args the arguments to process
Throws: OptionException if any problems occur
Parameters: commandLine the CommandLine to check.
Throws: OptionException if the CommandLine is not valid.