OpenJDK 1.22 · jdk.javadoc.internal.doclets.toolkit.AbstractDoclet

Modifier and Type	Field and Description
private BaseConfiguration	configuration The global configuration information for this run.
protected Messages	messages
protected Utils	utils

Access	Constructor and Description
public	AbstractDoclet()

Method Summary

Modifier and Type	Method and Description
private void	dumpStack(boolean enabled, Throwable t)
protected abstract void	generateClassFiles(SortedSet<TypeElement> the set of types to be documented arr, ClassTree the data structure representing the class tree classTree) Generate the class documentation.
protected void	generateClassFiles(ClassTree the data structure representing the class tree classTree) Iterate through all classes and construct documentation for them.
protected void	generateFiles() Start the generation of files.
protected abstract void	generateModuleFiles() Generate the module documentation.
protected void	generateOtherFiles(ClassTree the data structure representing the class tree classTree) Generate additional documentation that is added to the API documentation.
protected abstract void	generatePackageFiles(ClassTree the data structure representing the class tree classTree) Generate the package documentation.
public abstract BaseConfiguration	Returns: the configuration of the doclet. getConfiguration() Create the configuration instance and returns it.
protected Function<String, String>	getResourceKeyMapper(DocletEnvironment docEnv)
public SourceVersion	Returns: SourceVersion getSupportedSourceVersion() Implements jdk.javadoc.doclet.Doclet.getSupportedSourceVersion. Returns the SourceVersion indicating the features supported by this doclet.
private void	reportInternalError(Throwable t)
public boolean	Returns: true if the doclet executed without error. False otherwise. run(DocletEnvironment the `DocletEnvironment`. docEnv) Implements jdk.javadoc.doclet.Doclet.run. The method that starts the execution of the doclet.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

configuration	back to summary
private BaseConfiguration configuration The global configuration information for this run.

messages	back to summary
protected Messages messages

utils	back to summary
protected Utils utils

AbstractDoclet	back to summary
public AbstractDoclet()

Method Detail

dumpStack	back to summary
private void dumpStack(boolean enabled, Throwable t)

generateClassFiles	back to summary
protected abstract void generateClassFiles(SortedSet<TypeElement> arr, ClassTree classTree) throws DocletException Generate the class documentation. Parameters arr:SortedSet<TypeElement> the set of types to be documented classTree:ClassTree the data structure representing the class tree Exceptions DocletException: if there is a problem while generating the documentation

generateClassFiles

back to summary

protected abstract void generateClassFiles(SortedSet<TypeElement> arr, ClassTree classTree) throws DocletException

Generate the class documentation.

Parameters

arr:SortedSet<TypeElement>: the set of types to be documented
classTree:ClassTree: the data structure representing the class tree

Exceptions

DocletException:: if there is a problem while generating the documentation

generateClassFiles	back to summary
protected void generateClassFiles(ClassTree classTree) throws DocletException Iterate through all classes and construct documentation for them. Parameters classTree:ClassTree the data structure representing the class tree Exceptions DocletException: if there is a problem while generating the documentation

generateClassFiles

back to summary

protected void generateClassFiles(ClassTree classTree) throws DocletException

Iterate through all classes and construct documentation for them.

Parameters

classTree:ClassTree: the data structure representing the class tree

Exceptions

DocletException:: if there is a problem while generating the documentation

generateFiles	back to summary
protected void generateFiles() throws DocletException Start the generation of files. Call generate methods in the individual writers, which will in turn generate the documentation files. Call the TreeWriter generation first to ensure the Class Hierarchy is built first and then can be used in the later generation. Exceptions DocletException: if there is a problem while generating the documentation

generateFiles

back to summary

protected void generateFiles() throws DocletException

Start the generation of files. Call generate methods in the individual writers, which will in turn generate the documentation files. Call the TreeWriter generation first to ensure the Class Hierarchy is built first and then can be used in the later generation.

Exceptions

DocletException:: if there is a problem while generating the documentation

generateModuleFiles	back to summary
protected abstract void generateModuleFiles() throws DocletException Generate the module documentation. Exceptions DocletException: if there is a problem while generating the documentation

generateModuleFiles

back to summary

protected abstract void generateModuleFiles() throws DocletException

Generate the module documentation.

Exceptions

DocletException:: if there is a problem while generating the documentation

generateOtherFiles	back to summary
protected void generateOtherFiles(ClassTree classTree) throws DocletException Generate additional documentation that is added to the API documentation. Parameters classTree:ClassTree the data structure representing the class tree Exceptions DocletException: if there is a problem while generating the documentation

generateOtherFiles

back to summary

protected void generateOtherFiles(ClassTree classTree) throws DocletException

Generate additional documentation that is added to the API documentation.

Parameters

classTree:ClassTree: the data structure representing the class tree

Exceptions

DocletException:: if there is a problem while generating the documentation

generatePackageFiles	back to summary
protected abstract void generatePackageFiles(ClassTree classTree) throws DocletException Generate the package documentation. Parameters classTree:ClassTree the data structure representing the class tree Exceptions DocletException: if there is a problem while generating the documentation

generatePackageFiles

back to summary

protected abstract void generatePackageFiles(ClassTree classTree) throws DocletException

Generate the package documentation.

Parameters

classTree:ClassTree: the data structure representing the class tree

Exceptions

DocletException:: if there is a problem while generating the documentation

getConfiguration	back to summary
public abstract BaseConfiguration getConfiguration() Create the configuration instance and returns it. Returns:BaseConfiguration the configuration of the doclet.

getConfiguration

back to summary

public abstract BaseConfiguration getConfiguration()

Create the configuration instance and returns it.

Returns:BaseConfiguration: the configuration of the doclet.

getResourceKeyMapper	back to summary
protected Function<String, String> getResourceKeyMapper(DocletEnvironment docEnv)

getSupportedSourceVersion	back to summary
public SourceVersion getSupportedSourceVersion() Implements jdk.javadoc.doclet.Doclet.getSupportedSourceVersion. Returns the SourceVersion indicating the features supported by this doclet. Returns:SourceVersion SourceVersion Annotations @Override

getSupportedSourceVersion

back to summary

public SourceVersion getSupportedSourceVersion()

Implements jdk.javadoc.doclet.Doclet.getSupportedSourceVersion.

Returns the SourceVersion indicating the features supported by this doclet.

Returns:SourceVersion

SourceVersion

Annotations

@Override

reportInternalError	back to summary
private void reportInternalError(Throwable t)

run back to summary

run	back to summary
public boolean run(DocletEnvironment docEnv) Implements jdk.javadoc.doclet.Doclet.run. The method that starts the execution of the doclet. Parameters docEnv:DocletEnvironment the `DocletEnvironment`. Returns:boolean true if the doclet executed without error. False otherwise. Annotations @Override

public boolean run(DocletEnvironment docEnv)

Implements jdk.javadoc.doclet.Doclet.run.

The method that starts the execution of the doclet.

Parameters

docEnv:DocletEnvironment: the DocletEnvironment.

Returns:boolean

true if the doclet executed without error. False otherwise.

Annotations

@Override

public abstract Class AbstractDoclet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail