The user doclet must implement this interface, as described in the package description. Each implementation of a Doclet must provide a public no-argument constructor to be used by tools to instantiate the doclet. The tool infrastructure will interact with classes implementing this interface as follows:

The tool will create an instance of a doclet using the no-arg constructor of the doclet class.
Next, the tool calls the init method with an appropriate locale and reporter.
Afterwards, the tool calls getSupportedOptions, and getSupportedSourceVersion. These methods are only called once.
As appropriate, the tool calls the run method 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 and Inner Type Summary

Modifier and Type	Class and Description
public static interface	Doclet.Option An encapsulation of option name, aliases, parameters and descriptions as used by the Doclet.

Method Summary

Modifier and Type	Method and Description
public String	Returns: name of the Doclet getName() Returns a name identifying the doclet.
public Set<? extends Doclet.Option>	Returns: a set containing all the supported options, an empty set if none getSupportedOptions() Returns all the supported options.
public SourceVersion	Returns: the language version supported by this doclet, usually the latest version getSupportedSourceVersion() Returns the version of the Java Programming Language supported by this doclet.
public void	init(Locale the locale to be used locale, Reporter the reporter to be used reporter) Initializes this doclet with the given locale and error reporter.
public boolean	Returns: true on success run(DocletEnvironment from which essential information can be extracted environment) The entry point of the doclet.

Method Detail

getName	back to summary
public String 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". Returns:String name of the Doclet

getName

back to summary

public String 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".

Returns:String: name of the Doclet

getSupportedOptions	back to summary
public Set<? extends Doclet.Option> getSupportedOptions() Returns all the supported options. Returns:Set<? extends Doclet.Option> a set containing all the supported options, an empty set if none

getSupportedOptions

back to summary

public Set<? extends Doclet.Option> getSupportedOptions()

Returns all the supported options.

Returns:Set<? extends Doclet.Option>: a set containing all the supported options, an empty set if none

getSupportedSourceVersion	back to summary
public SourceVersion getSupportedSourceVersion() Returns the version of the Java Programming Language supported by this doclet. Returns:SourceVersion the language version supported by this doclet, usually the latest version

getSupportedSourceVersion

back to summary

public SourceVersion getSupportedSourceVersion()

Returns the version of the Java Programming Language supported by this doclet.

Returns:SourceVersion: the language version supported by this doclet, usually the latest version

init	back to summary
public void init(Locale locale, Reporter reporter) Initializes this doclet with the given locale and error reporter. This locale will be used by the reporter and the doclet components. Parameters locale:Locale the locale to be used reporter:Reporter the reporter to be used

init

back to summary

public void init(Locale locale, Reporter reporter)

Initializes this doclet with the given locale and error reporter. This locale will be used by the reporter and the doclet components.

Parameters

locale:Locale: the locale to be used
reporter:Reporter: the reporter to be used

run	back to summary
public boolean run(DocletEnvironment environment) The entry point of the doclet. Further processing will commence as instructed by this method. Parameters environment:DocletEnvironment from which essential information can be extracted Returns:boolean true on success

run

back to summary

public boolean run(DocletEnvironment environment)

The entry point of the doclet. Further processing will commence as instructed by this method.

Parameters

environment:DocletEnvironment: from which essential information can be extracted

Returns:boolean

true on success

jdk.javadoc.doclet back to summary

public Interface Doclet.Option

Known Direct Implementers: jdk.javadoc.internal.doclets.toolkit.BaseOptions.Option

An encapsulation of option name, aliases, parameters and descriptions as used by the Doclet.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	Doclet.Option.Kind The kind of an option.

Method Summary

Modifier and Type	Method and Description
public int	Returns: number of consumed arguments getArgumentCount() Returns the number of arguments, this option will consume.
public String	Returns: description if set, otherwise an empty String getDescription() Returns the description of the option.
public Doclet.Option.Kind	Returns: the kind of this option getKind() Returns the option kind.
public List<String>	Returns: the names of the option getNames() Returns the list of names that may be used to identify the option.
public String	Returns: parameters if set, otherwise an empty String getParameters() Returns the parameters of the option.
public boolean	Returns: true if operation succeeded, false otherwise process(String the option option, List<String> a list encapsulating the arguments arguments) Processes the option and arguments as needed.

Method Detail

getArgumentCount	back to summary
public int getArgumentCount() Returns the number of arguments, this option will consume. Returns:int number of consumed arguments

getArgumentCount

back to summary

public int getArgumentCount()

Returns the number of arguments, this option will consume.

Returns:int: number of consumed arguments

getDescription	back to summary
public String 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:String description if set, otherwise an empty String

getDescription

back to summary

public String 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:String: description if set, otherwise an empty String

getKind	back to summary
public Doclet.Option.Kind getKind() Returns the option kind. Returns:Doclet.Option.Kind the kind of this option

getKind

back to summary

public Doclet.Option.Kind getKind()

Returns the option kind.

Returns:Doclet.Option.Kind: the kind of this option

getNames back to summary

getNames	back to summary
public List<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:List<String> the names of the option

public List<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:List<String>: the names of the option

getParameters	back to summary
public String getParameters() Returns the parameters of the option. For instance "name <p1>:<p2>.." Returns:String parameters if set, otherwise an empty String

getParameters

back to summary

public String getParameters()

Returns the parameters of the option. For instance "name <p1>:<p2>.."

Returns:String: parameters if set, otherwise an empty String

process	back to summary
public boolean 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:String the option arguments:List<String> a list encapsulating the arguments Returns:boolean true if operation succeeded, false otherwise

process

back to summary

public boolean 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:String: the option
arguments:List<String>: a list encapsulating the arguments

Returns:boolean

true if operation succeeded, false otherwise

jdk.javadoc.doclet back to summary

public final Enum Doclet.Option.Kind

Class Inheritance

extends Enum<Doclet.Option.Kind>

java.lang.Object
java.lang.Enum
jdk.javadoc.doclet.Doclet.Option.Kind

The kind of an option.

Field Summary

Modifier and Type	Field and Description
public static final Doclet.Option.Kind	EXTENDED An extended option, such as those prefixed with `-X`.
public static final Doclet.Option.Kind	OTHER An implementation-reserved option.
public static final Doclet.Option.Kind	STANDARD A standard option.

Constructor Summary

Access	Constructor and Description
private	Kind()

Method Summary

Modifier and Type	Method and Description
public static Doclet.Option.Kind	valueOf(String name)
public static Doclet.Option.Kind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

EXTENDED	back to summary
public static final Doclet.Option.Kind EXTENDED An extended option, such as those prefixed with `-X`.

OTHER	back to summary
public static final Doclet.Option.Kind OTHER An implementation-reserved option.

STANDARD	back to summary
public static final Doclet.Option.Kind STANDARD A standard option.

Constructor Detail

Kind	back to summary
private Kind()

Method Detail

valueOf	back to summary
public static Doclet.Option.Kind valueOf(String name)

values	back to summary
public static Doclet.Option.Kind[] values()