|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Option
The super type of all options representing a particular element of the command line interface.
Method Summary | |
---|---|
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. |
Method Detail |
---|
void process(WriteableCommandLine commandLine, ListIterator args) throws OptionException
commandLine
- the CommandLine object to store results inargs
- the arguments to process
OptionException
- if any problems occurvoid defaults(WriteableCommandLine commandLine)
commandLine
- the CommandLine object to store defaults inboolean canProcess(WriteableCommandLine commandLine, String argument)
commandLine
- the CommandLine object to store defaults inargument
- the argument to be tested
boolean canProcess(WriteableCommandLine commandLine, ListIterator arguments)
commandLine
- the CommandLine object to store defaults inarguments
- the ListIterator over String arguments
canProcess(WriteableCommandLine,String)
Set getTriggers()
Set getPrefixes()
void validate(WriteableCommandLine commandLine) throws OptionException
commandLine
- the CommandLine to check.
OptionException
- if the CommandLine is not valid.List helpLines(int depth, Set helpSettings, Comparator comp)
depth
- the initial indent depthhelpSettings
- the HelpSettings that should be appliedcomp
- a comparator used to sort options when applicable.
HelpLine
,
HelpFormatter
void appendUsage(StringBuffer buffer, Set helpSettings, Comparator comp)
buffer
- the buffer to append tohelpSettings
- a set of display settings @see DisplaySettingcomp
- a comparator used to sort the OptionsString getPreferredName()
String getDescription()
HelpFormatter
int getId()
for(Option o : cmd.getOptions()){
switch(o.getId()){
case POTENTIAL_OPTION:
...
}
}
The returned value is not guarenteed to be unique.
Option findOption(String trigger)
trigger
- the trigger to search for.
boolean isRequired()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |