- Enclosing interface:
- Doclet
public static interface Doclet.Option
An encapsulation of option name, aliases, parameters and descriptions
 as used by the Doclet.
- 
Nested Class SummaryNested Classes
- 
Method SummaryModifier and TypeMethodDescriptionintReturns the number of arguments, this option will consume.Returns the description of the option.getKind()Returns the option kind.getNames()Returns the list of names that may be used to identify the option.Returns the parameters of the option.booleanProcesses the option and arguments as needed.
- 
Method Details- 
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
 
- 
getNamesReturns 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
 
- 
processProcesses 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
 
 
-