|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface OptionDescriptor
Describes options that an option parser recognizes, in ways that might be useful to help screens.
| Method Summary | |
|---|---|
boolean |
acceptsArguments()
Does this option accept arguments? |
String |
argumentDescription()
Gives a short description of the option's argument. |
String |
argumentTypeIndicator()
Gives an indication of the expected type of the option's argument. |
List<?> |
defaultValues()
What values will the option take if none are specified on the command line? |
String |
description()
Description of this option's purpose. |
boolean |
isRequired()
Is this option required on a command line? |
Collection<String> |
options()
A set of options that are mutually synonymous. |
boolean |
representsNonOptions()
Tells whether this object represents the non-option arguments of a command line. |
boolean |
requiresArgument()
Does this option require an argument? |
| Method Detail |
|---|
Collection<String> options()
String description()
List<?> defaultValues()
boolean isRequired()
boolean acceptsArguments()
boolean requiresArgument()
String argumentDescription()
String argumentTypeIndicator()
boolean representsNonOptions()
true if this represents non-option arguments
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||