- All Known Implementing Classes:
public interface Doclet
- The tool will create an instance of a doclet using the no-arg constructor of the doclet class.
- Next, the tool calls the
initmethod with an appropriate locale and reporter.
- Afterwards, the tool calls
getSupportedSourceVersion. These methods are only called once.
- As appropriate, the tool calls the
runmethod on the doclet object, giving it a DocletEnvironment object, from which the doclet can determine the elements to be included in the documentation.
If a doclet object is created and used without the above protocol being followed, then the doclet's behavior is not defined by this interface specification.
To start the doclet, pass
-doclet followed by the fully-qualified
name of the entry point class (i.e. the implementation of this interface) on
the javadoc tool command line.
Nested Class Summary
Nested Classes Modifier and Type Interface Description
static interfaceAn encapsulation of option name, aliases, parameters and descriptions as used by the Doclet.
Modifier and Type Method Description
()Returns a name identifying the doclet.
Set<? extends Doclet.Option>
()Returns all the supported options.
()Returns the version of the Java Programming Language supported by this doclet.
Locale locale, Reporter reporter)(Initializes this doclet with the given locale and error reporter.
DocletEnvironment environment)(The entry point of the doclet.
initInitializes this doclet with the given locale and error reporter. This locale will be used by the reporter and the doclet components.
locale- the locale to be used
reporter- the reporter to be used
getNameString getName()Returns a name identifying the doclet. A name is a simple identifier without white spaces, as defined in The Java™ Language Specification, section 6.2 "Names and Identifiers".
- name of the Doclet
getSupportedOptionsReturns all the supported options.
- a set containing all the supported options, an empty set if none
getSupportedSourceVersionSourceVersion getSupportedSourceVersion()Returns the version of the Java Programming Language supported by this doclet.
- the language version supported by this doclet, usually the latest version
runboolean run(DocletEnvironment environment)The entry point of the doclet. Further processing will commence as instructed by this method.
environment- from which essential information can be extracted
- true on success