Nested and Inner Type Summary

Modifier and Type	Class and Description
private static record	HtmlDoclet.ReadableResource

Field Summary

Modifier and Type	Field and Description
private HtmlConfiguration	configuration Hides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.configuration. The global configuration information for this run.
private final Doclet	initiatingDoclet The initiating doclet, to be specified when creating the configuration.
private Messages	messages Hides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.messages. Object for generating messages and diagnostics.
private WriterFactory	writerFactory Factory for page- and member-writers.

Inherited from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet:: utils

Constructor Summary

Access	Constructor and Description
public	HtmlDoclet(Doclet the initiating doclet initiatingDoclet) Creates a doclet to generate HTML documentation, specifying the "initiating doclet" to be used when initializing any taglets for this doclet.

Method Summary

Modifier and Type	Method and Description
private void	copyFile(String filename, DocPath targetPath)
private void	copyFontResources()
private void	copyLegalFiles(boolean includeJQuery, boolean includeHighlightJs)
private void	copyResource(DocPath sourcePath, DocPath targetPath, boolean replaceNewLine)
private void	copyStylesheet(HtmlOptions options)
public void	generateClassFiles(ClassTree classTree) Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateClassFiles. Iterate through all classes and construct documentation for them.
protected void	generateClassFiles(SortedSet<TypeElement> typeElems, ClassTree classTree) Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateClassFiles. Generate the class documentation.
protected void	generateFiles() Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateFiles. Start the generation of files.
protected void	generateModuleFiles() Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateModuleFiles. Generate the module documentation.
protected void	generateOtherFiles(ClassTree classTree) Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateOtherFiles. Start the generation of files.
protected void	generatePackageFiles(ClassTree classTree) Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generatePackageFiles. Generate the package documentation.
public HtmlConfiguration	Returns: the configuration getConfiguration() Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.getConfiguration. Create the configuration instance.
public String	getName() Implements jdk.javadoc.doclet.Doclet.getName. Returns a name identifying the doclet.
protected Function<String, String>	getResourceKeyMapper(DocletEnvironment docEnv) Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.getResourceKeyMapper.
public Set<? extends Doclet.Option>	getSupportedOptions() Implements jdk.javadoc.doclet.Doclet.getSupportedOptions. Returns all the supported options.
public void	init(Locale locale, Reporter reporter) Implements jdk.javadoc.doclet.Doclet.init. Initializes this doclet with the given locale and error reporter.
private HtmlDoclet.ReadableResource	resolveResource(DocPath sourcePath)

Inherited from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet:: getSupportedSourceVersion run

Field Detail

configuration back to summary

configuration	back to summary
private HtmlConfiguration configuration Hides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.configuration. The global configuration information for this run. Initialized in `init(Locale, Reporter)`.

private HtmlConfiguration configuration

Hides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.configuration.

The global configuration information for this run. Initialized in init(Locale, Reporter).

initiatingDoclet	back to summary
private final Doclet initiatingDoclet The initiating doclet, to be specified when creating the configuration.

messages	back to summary
private Messages messages Hides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.messages. Object for generating messages and diagnostics.

messages

back to summary

private Messages messages

Hides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.messages.

Object for generating messages and diagnostics.

writerFactory	back to summary
private WriterFactory writerFactory Factory for page- and member-writers.

Constructor Detail

HtmlDoclet	back to summary
public HtmlDoclet(Doclet initiatingDoclet) Creates a doclet to generate HTML documentation, specifying the "initiating doclet" to be used when initializing any taglets for this doclet. An initiating doclet is one that delegates to this doclet. Parameters initiatingDoclet:Doclet the initiating doclet

HtmlDoclet

back to summary

public HtmlDoclet(Doclet initiatingDoclet)

Creates a doclet to generate HTML documentation, specifying the "initiating doclet" to be used when initializing any taglets for this doclet. An initiating doclet is one that delegates to this doclet.

Parameters

initiatingDoclet:Doclet: the initiating doclet

Method Detail

copyFile	back to summary
private void copyFile(String filename, DocPath targetPath) throws DocFileIOException

copyFontResources	back to summary
private void copyFontResources() throws DocletException

copyLegalFiles	back to summary
private void copyLegalFiles(boolean includeJQuery, boolean includeHighlightJs) throws DocletException

copyResource	back to summary
private void copyResource(DocPath sourcePath, DocPath targetPath, boolean replaceNewLine) throws DocletException

copyStylesheet	back to summary
private void copyStylesheet(HtmlOptions options) throws DocletException

generateClassFiles	back to summary
public void generateClassFiles(ClassTree classTree) throws DocletException Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateClassFiles. Doc from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateClassFiles. Iterate through all classes and construct documentation for them. Annotations @Override Exceptions DocletException: if there is a problem while generating the documentation

generateClassFiles

back to summary

public void generateClassFiles(ClassTree classTree) throws DocletException

Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateClassFiles.

Doc from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateClassFiles.

Iterate through all classes and construct documentation for them.

Annotations

@Override

Exceptions

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

generateClassFiles	back to summary
protected void generateClassFiles(SortedSet<TypeElement> typeElems, ClassTree classTree) throws DocletException Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateClassFiles. Doc from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateClassFiles. Generate the class documentation. Annotations @Override Exceptions DocletException: if there is a problem while generating the documentation

generateClassFiles

back to summary

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

Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateClassFiles.

Doc from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateClassFiles.

Generate the class documentation.

Annotations

@Override

Exceptions

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

generateFiles	back to summary
protected void generateFiles() throws DocletException Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateFiles. Doc from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateFiles. 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. Annotations @Override Exceptions DocletException: if there is a problem while generating the documentation

generateFiles

back to summary

protected void generateFiles() throws DocletException

Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateFiles.

Doc from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateFiles.

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.

Annotations

@Override

Exceptions

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

generateModuleFiles	back to summary
protected void generateModuleFiles() throws DocletException Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateModuleFiles. Doc from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateModuleFiles. Generate the module documentation. Annotations @Override Exceptions DocletException: if there is a problem while generating the documentation

generateModuleFiles

back to summary

protected void generateModuleFiles() throws DocletException

Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateModuleFiles.

Doc from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateModuleFiles.

Generate the module documentation.

Annotations

@Override

Exceptions

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

generateOtherFiles	back to summary
protected void generateOtherFiles(ClassTree classTree) throws DocletException Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateOtherFiles. 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. Annotations @Override Exceptions DocletException: if there is a problem while writing the other files

generateOtherFiles

back to summary

protected void generateOtherFiles(ClassTree classTree) throws DocletException

Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generateOtherFiles.

Annotations

@Override

Exceptions

DocletException:: if there is a problem while writing the other files

generatePackageFiles	back to summary
protected void generatePackageFiles(ClassTree classTree) throws DocletException Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generatePackageFiles. Doc from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generatePackageFiles. Generate the package documentation. Annotations @Override Exceptions DocletException: if there is a problem while generating the documentation

generatePackageFiles

back to summary

protected void generatePackageFiles(ClassTree classTree) throws DocletException

Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generatePackageFiles.

Doc from jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.generatePackageFiles.

Generate the package documentation.

Annotations

@Override

Exceptions

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

getConfiguration	back to summary
public HtmlConfiguration getConfiguration() Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.getConfiguration. Create the configuration instance. Override this method to use a different configuration. Returns:HtmlConfiguration the configuration Annotations @Override

getConfiguration

back to summary

public HtmlConfiguration getConfiguration()

Implements abstract jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.getConfiguration.

Create the configuration instance. Override this method to use a different configuration.

Returns:HtmlConfiguration

the configuration

Annotations

@Override

getName	back to summary
public String getName() Implements jdk.javadoc.doclet.Doclet.getName. Doc from jdk.javadoc.doclet.Doclet.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". Annotations @Override

getName

back to summary

public String getName()

Implements jdk.javadoc.doclet.Doclet.getName.

Doc from jdk.javadoc.doclet.Doclet.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".

Annotations

@Override

getResourceKeyMapper	back to summary
protected Function<String, String> getResourceKeyMapper(DocletEnvironment docEnv) Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.getResourceKeyMapper. Annotations @Override

getResourceKeyMapper

back to summary

protected Function<String, String> getResourceKeyMapper(DocletEnvironment docEnv)

Overrides jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.getResourceKeyMapper.

Annotations

@Override

getSupportedOptions	back to summary
public Set<? extends Doclet.Option> getSupportedOptions() Implements jdk.javadoc.doclet.Doclet.getSupportedOptions. Doc from jdk.javadoc.doclet.Doclet.getSupportedOptions. Returns all the supported options. Annotations @Override

getSupportedOptions

back to summary

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

Implements jdk.javadoc.doclet.Doclet.getSupportedOptions.

Doc from jdk.javadoc.doclet.Doclet.getSupportedOptions.

Returns all the supported options.

Annotations

@Override

init	back to summary
public void init(Locale locale, Reporter reporter) Implements jdk.javadoc.doclet.Doclet.init. Doc from jdk.javadoc.doclet.Doclet.init. Initializes this doclet with the given locale and error reporter. This locale will be used by the reporter and the doclet components. Annotations @Override

init

back to summary

public void init(Locale locale, Reporter reporter)

Implements jdk.javadoc.doclet.Doclet.init.

Doc from jdk.javadoc.doclet.Doclet.init.

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

Annotations

@Override

resolveResource	back to summary
private HtmlDoclet.ReadableResource resolveResource(DocPath sourcePath) throws ResourceIOException

jdk.javadoc.internal.doclets.formats.html back to summary

private final Record HtmlDoclet.ReadableResource

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
jdk.javadoc.internal.doclets.formats.html.HtmlDoclet.ReadableResource

Record Components

path:DocPath
url:URL

Field Summary

Modifier and Type	Field and Description
private final DocPath	path Record Component accessed by path().
private final URL	url Record Component accessed by url().

Constructor Summary

Access	Constructor and Description
private	ReadableResource(DocPath path, URL url)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public DocPath	path() Record Component getter of path.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public URL	url() Record Component getter of url.

Field Detail

path	back to summary
private final DocPath path Record Component accessed by path().

url	back to summary
private final URL url Record Component accessed by url().

Constructor Detail

ReadableResource	back to summary
private ReadableResource(DocPath path, URL url)

Method Detail

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

path	back to summary
public DocPath path() Record Component getter of path.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

url	back to summary
public URL url() Record Component getter of url.

public Class HtmlDoclet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record HtmlDoclet.ReadableResource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail