- 
- Enclosing interface:
- Doclet
 
 public static interface Doclet.OptionAn encapsulation of option name, aliases, parameters and descriptions as used by the Doclet.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Interface Description static classDoclet.Option.KindThe kind of an option.
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description intgetArgumentCount()Returns the number of arguments, this option will consume.StringgetDescription()Returns the description of the option.Doclet.Option.KindgetKind()Returns the option kind.List<String>getNames()Returns the list of names that may be used to identify the option.StringgetParameters()Returns the parameters of the option.booleanprocess(String option, List<String> arguments)Processes the option and arguments as needed.
 
- 
- 
- 
Method Detail- 
getArgumentCountint getArgumentCount() Returns the number of arguments, this option will consume.- Returns:
- number of consumed arguments
 
 - 
getDescriptionString getDescription() Returns the description of the option. For instance, the option "group", would return the synopsis of the option such as, "groups the documents".- Returns:
- description if set, otherwise an empty String
 
 - 
getKindDoclet.Option.Kind getKind() Returns the option kind.- Returns:
- the kind of this option
 
 - 
getNamesList<String> getNames() Returns the list of names that may be used to identify the option. For instance, the list could be["-classpath", "--class-path"]for the option "-classpath", with an alias "--class-path".- Returns:
- the names of the option
 
 - 
getParametersString getParameters() Returns the parameters of the option. For instance "name <p1>:<p2>.."- Returns:
- parameters if set, otherwise an empty String
 
 - 
processboolean process(String option, List<String> arguments) Processes the option and arguments as needed. This method will be invoked if the given option name matches the option.- Parameters:
- option- the option
- arguments- a list encapsulating the arguments
- Returns:
- true if operation succeeded, false otherwise
 
 
- 
 
-