OpenJDK 27 · jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter

Modifier and Type	Class and Description
private class	HtmlDocletWriter.InlineVisitor
private class	HtmlDocletWriter.MarkdownHandler

Modifier and Type	Field and Description
private boolean	commentRemoved
protected final Comparators	comparators
public final HtmlConfiguration	configuration The global configuration information for this run.
protected final Contents	contents
protected final DocPaths	docPaths
private static final Pattern	docrootPattern
private final Set<String>	headingIds
protected final HtmlIds	htmlIds
public final Map<String, Integer>	indexAnchorTable A table of the anchors used for at-index and related tags, so that they can be made unique by appending a suitable suffix.
private boolean	isAnnotationDocumented To check whether the repeated annotations is documented or not.
private boolean	isContainerDocumented To check whether the container annotations is documented or not.
public final Links	links
protected Script	mainBodyScript
public final Messages	messages
protected final HtmlOptions	options
public final DocPath	path Platform-independent path from the current or the destination directory to the file getting generated.
public final DocPath	pathToRoot Relative path from the file getting generated to the destination directory.
protected final Resources	resources
protected final TableOfContents	tableOfContents
protected final Utils	utils
protected String	winTitle The window title of this file.

Access	Constructor and Description
public	HtmlDocletWriter(HtmlConfiguration the configuration for this doclet configuration, DocPath the file to be generated. path) Creates an `HtmlDocletWriter`.
protected	HtmlDocletWriter(HtmlConfiguration the configuration for this doclet configuration, DocPath the file to be generated. path, boolean whether to write a "Generating ..." message to the console generating) Creates an `HtmlDocletWriter`.

Method Summary

Modifier and Type	Method and Description
private void	addAnnotations(TypeElement the annotation being documented annotationDoc, HtmlLinkInfo the information about the link linkInfo, ContentBuilder the annotation string to which the annotation will be added annotation, Map<? extends ExecutableElement, ? extends AnnotationValue> annotation type element to annotation value pairs map, boolean if true, add new line between each member value linkBreak) Add annotation to the annotation string.
private void	addCommentTags(Element the Element for which the comment tags will be generated element, List<? extends DocTree> the first sentence tags for the doc tags, boolean true if it is deprecated depr, boolean true if the first sentence tags should be added first, boolean true if the comment tags are added into the summary section inSummary, Content the content to which the comment tags will be added target) Adds the comment tags.
public void	addInlineComment(Element the Element for which the inline comment will be added element, DocTree the inline tag to be added tag, Content the content to which the comment will be added target) Add the inline comment.
public void	addInlineComment(Element the element for which the content will be added element, Content the content to which the content will be added target) Adds the full-body content of the given element.
public void	addInlineDeprecatedComment(Element the Element for which the inline deprecated comment will be added e, DeprecatedTree the inline tag to be added tag, Content the content to which the comment will be added target) Add the inline deprecated comment.
private void	addMethodInfo(ExecutableElement the method to be documented method, Content the content to which the method information will be added dl) Add method information.
public void	addPreQualifiedClassLink(HtmlLinkInfo.Kind the id of the context where the link will be added context, TypeElement the class to link to typeElement, Content the content to which the link will be added target) Adds a link to the given class.
public void	addPreQualifiedClassLink(HtmlLinkInfo.Kind the id of the context where the link will be added context, TypeElement the class to link to typeElement, HtmlStyle optional style for the link style, Content the content to which the link with be added target) Add the class link with the package portion of the label in plain text.
public void	addPreQualifiedStrongClassLink(HtmlLinkInfo.Kind the id of the context where the link will be added context, TypeElement the class to link to typeElement, Content the content to which the link with be added content) Add the class link, with only class name as the strong link and prefixing plain package name.
public void	addPreviewComment(Element the Element for which the summary will be generated element, List<? extends DocTree> the first sentence tags for the doc firstSentenceTags, Content the content to which the summary will be added target) Adds the preview content.
public void	addPreviewInfo(Element forWhat, Content target)
public void	addPreviewSummary(Element forWhat, Content target)
public void	addRestrictedInfo(ExecutableElement forWhat, Content target)
public void	addRestrictedSummary(Element forWhat, Content target)
public void	addSrcLink(Element program element for which the link will be added element, Content label for the link label, Content the content to which the link will be added target) Add the link to the content.
public void	addSummaryComment(Element the Element for which the summary will be generated element, Content the content to which the summary will be added target) Adds the summary content.
public void	addSummaryComment(Element the Element for which the summary will be generated element, List<? extends DocTree> the first sentence tags for the doc firstSentenceTags, Content the content to which the summary will be added target) Adds the summary content.
public void	addSummaryDeprecatedComment(Element element, DeprecatedTree tag, Content target)
protected void	addTagsInfo(Element the Element for which the tags will be generated e, Content the content to which the tags will be added content) Adds the tags information.
private Content	annotationValueToContent(AnnotationValue annotationValue)
public abstract void	buildPage() The top-level method to generate and write the page represented by this writer.
public Content	Returns: a Content object commentTagsToContent(Element specific element where comment resides element, List<? extends DocTree> list of text trees and inline tag trees (often alternating) tags, boolean true if text is first sentence isFirstSentence) Converts inline tags and text to content, expanding the inline tags along the way.
public Content	Returns: a Content object commentTagsToContent(Element specific element where comment resides element, List<? extends DocTree> list of text trees and inline tag trees (often alternating) trees, boolean true if text is first sentence isFirstSentence, boolean if the comment tags are added into the summary section inSummary) Converts inline tags and text to content, expanding the inline tags along the way.
public Content	Returns: a Content object commentTagsToContent(Element specific element where comment resides element, List<? extends DocTree> list of text trees and inline tag trees (often alternating) trees, TagletWriter.Context the enclosing context for the trees context) Converts inline tags and text to content, expanding the inline tags along the way.
private void	createSectionIdAndIndex(StartElementTree node, List<? extends DocTree> trees, Content attrs, Element element, TagletWriter.Context context)
protected TableOfContents	Returns: a table of contents createTableOfContents() Creates table of contents for this writer.
private boolean	equalsIgnoreCase(Name name, String s)
pack-priv Content	Returns: the annotation types info for the given element getAnnotationInfo(Element an Element element, boolean if true add new line between each member value lineBreak) Returns the annotation types info for the given element.
pack-priv Content	Returns: the description for the given annotations getAnnotationInfo(List<? extends AnnotationMirror> a list of annotation mirrors descList, boolean if true add new line between each member value lineBreak) Returns the description for the given annotations.
public List<Content>	Returns: a list of strings representing the annotations being documented. getAnnotations(List<? extends AnnotationMirror> a list of annotation mirrors. descList, boolean if true, add new line between each member value. lineBreak) Return the string representations of the annotation types for the given doc.
protected Content	Returns: the content getBlockTagOutput(Element the element element) Returns the content generated from the default supported set of block tags for this element.
protected Content	Returns: the content getBlockTagOutput(Element the element element, List<Taglet> the taglets to handle the required set of tags taglets) Returns the content generated from a specified set of block tags for this element.
public HtmlTree	Returns: an HtmlTree for the BODY tag getBody(String title for the window title) Returns an HtmlTree for the BODY element.
public HtmlStyle	getBodyStyle()
public Content	Returns: the link getCrossClassLink(TypeElement the class element classElement, String the name of the member being referenced. This should be null or empty string if no member is being referenced. refMemName, Content the label for the external link. label, String the title for the link title, HtmlStyle optional style for the link. style, boolean true if the label should be code font. code) Return a class cross-link to external class documentation.
public DocLink	getCrossModuleLink(ModuleElement element)
public DocLink	getCrossPackageLink(PackageElement element)
public TypeElement	Returns: the type element documented by this writer if it is a `ClassWriter`, or null for any other kind of writer getCurrentTypeElement() Returns the type element documented by this writer if it is a `ClassWriter`, or null for any other kind of writer.
public Content	Returns: a phrase describing the type of deprecation getDeprecatedPhrase(Element the Element for which the inline deprecated comment will be added e) Returns a phrase describing the type of deprecation.
pack-priv static String	Returns: the description getDescription(String a prefix for the string prefix, Element the element elem) Generates a string for use in a description meta element, based on an element and its enclosing elements
public Content	Returns: a link to the given member getDocLink(HtmlLinkInfo.Kind the id of the context where the link will be added context, Element the member being linked to element, CharSequence the label for the link label) Returns a link to the given member.
public Content	Returns: the link for the given member. getDocLink(HtmlLinkInfo.Kind the id of the context where the link will be printed. context, TypeElement the typeElement that we should link to. This is not necessarily the type containing element since we may be inheriting comments. typeElement, Element the member being linked to. element, CharSequence the label for the link. label) Return the link for the given member.
public Content	Returns: the link for the given member. getDocLink(HtmlLinkInfo.Kind the id of the context where the link will be printed. context, TypeElement the typeElement that we should link to. This is not necessarily the type containing element since we may be inheriting comments. typeElement, Element the member being linked to. element, CharSequence the label for the link. label, HtmlStyle optional style for the link. style) Return the link for the given member.
public Content	Returns: the link for the given member. getDocLink(HtmlLinkInfo.Kind the id of the context where the link will be printed. context, TypeElement the typeElement that we should link to. This is not necessarily the type containing element since we may be inheriting comments. typeElement, Element the member being linked to. element, CharSequence the label for the link. label, boolean isProperty) Return the link for the given member.
public Content	Returns: the link for the given member. getDocLink(HtmlLinkInfo.Kind the id of the context where the link will be printed. context, TypeElement the typeElement that we should link to. This is not necessarily the type containing element since we may be inheriting comments. typeElement, Element the member being linked to. element, Content the label for the link. label, HtmlStyle optional style to use for the link. style, boolean true if the element parameter is a JavaFX property. isProperty) Return the link for the given member.
public String	Returns: the name getEnclosingPackageName(TypeElement TypeElement te) Get the enclosed name of the package
public String	Returns: the title for a doc-file element getFileTitle(DocFileElement the doc-file element element) Returns the title for a doc-file element.
public HtmlTree	Returns: the `<footer>` element or `null`. getFooter() Returns a `<footer>` element containing the user's "bottom" text, or `null` if there is no such text.
pack-priv static String	getGenerator(Class<?> clazz)
protected Content	Returns: the `<header>` element getHeader(Navigation.PageMode the pageMode used to configure the navigation bar pageMode) Returns a `<header>` element, containing the user "top" text, if any, and the main navigation bar.
protected Content	Returns: the `<header>` element getHeader(Navigation.PageMode the page mode used to configure the navigation bar pageMode, Element the element used to configure the navigation bar element) Returns a `<header>` element, containing the user "top" text, if any, and the main navigation bar.
private String	Returns: the content of the `<h1>` heading in the given content, or an empty string if there is no such heading getHeadingText(Content the content c) Returns the content of the `<h1>` heading in the given content, or an empty string if there is no such heading.
private Optional<String>	getIdAttributeValue(StartElementTree node)
private Content	getInlineTagOutput(Element element, InlineTagTree tree, TagletWriter.Context context)
public Content	Returns: the link for the given class. getLink(HtmlLinkInfo the information about the link. linkInfo) Return the link to the given class.
public Content	Returns: a package name getLocalizedPackageName(PackageElement the package to get the name for packageElement) Returns a package name.
pack-priv List<DocPath>	Returns: list of path of module/package specific stylesheets getLocalStylesheets(Element module/Package element element) Returns the path of module/package specific stylesheets for the element.
public Content	Returns: a link to module getModuleLink(ModuleElement the module being documented mdle, Content tag for the link label) Returns a link to module.
public Content	Returns: a link to module getModuleLink(ModuleElement the module being documented mdle, Content tag for the link label, String the link fragment fragment) Returns a link to module.
private List<DocPath>	getModuleStylesheets(PackageElement pkgElement)
protected Navigation	Returns: the basic navigation bar getNavBar(Navigation.PageMode the page mode pageMode, Element the defining element for the navigation bar, or `null` if none element) Returns a basic navigation bar for a kind of page and element.
protected Content	Returns: an "overview tree" link for a navigation bar getNavLinkToOverviewTree(String the label for the link label) Returns an "overview tree" link for a navigation bar.
public Content	Returns: the package name content getPackageLabel(CharSequence the package name packageName) Returns a package name label.
public Content	Returns: the link to the given package getPackageLink(PackageElement the package to link to packageElement, Content the label for the link label) Returns the link to the given package.
public Content	Returns: the link to the given package getPackageLink(PackageElement the package to link to packageElement, Content the label for the link label, String the link fragment fragment) Returns the link to the given package.
protected TableHeader	getPackageTableHeader()
public Content	Returns: the link with the package portion of the label in plain text. getPreQualifiedClassLink(HtmlLinkInfo.Kind context, TypeElement the class to link to. typeElement) Retrieve the class link with the package portion of the label in plain text.
private List<Content>	getPreviewNotes(TypeElement el)
public Content	Returns: a link to the given class getQualifiedClassLink(HtmlLinkInfo.Kind the id of the context where the link will be added context, Element the class to link to element) Returns a link to the given class.
private Content	getRestrictedMethodDocLink()
private List<DocPath>	getStylesheets(Element element)
public TagletWriter	Returns: a TagletWriter that knows how to write HTML. getTagletWriterInstance(boolean true if we want to write the first sentence isFirstSentence) Returns a TagletWriter that knows how to write HTML.
public TagletWriter	Returns: a TagletWriter getTagletWriterInstance(TagletWriter.Context the enclosing context context) Returns a TagletWriter that knows how to write HTML.
private String	Returns: the plain-text content of a named HTML element in a list of content getTextContent(List<? extends DocTree> the list of content trees, String the name og the HTML element name) Returns the plain-text content of a named HTML element in a list of content.
public Content	Returns: the type for the given class. getTypeParameterLinks(HtmlLinkInfo the information about the link. linkInfo) Return the type parameters for the given class.
public String	Returns: the window title string getWindowTitle(String the title string to construct the complete window title title) Returns the window title.
protected boolean	Returns: `true` if and only if there are tags to be included hasSerializationOverviewTags(VariableElement the field to check field) Returns whether there are any tags in a field for the Serialization Overview section to be generated.
pack-priv boolean	ignoreNonInlineTag(DocTree dtree, List<Name> openTags)
private boolean	includeHeadingInTableOfContents(String tag)
private boolean	inSamePackage(Element element) Returns true if element lives in the same package as the type or package element of this writer.
public Content	Returns: the output invalidTagOutput(String the single-line summary message summary, Optional<Content> the optional detail message which may contain preformatted text detail) Returns the output for an invalid tag.
private boolean	Returns: true if the annotation contains an array of annotation as a value. isAnnotationArray(Map<? extends ExecutableElement, ? extends AnnotationValue> annotation type element and value pairs pairs) Check if the annotation contains an array of annotation as a value.
private static boolean	isBlank(String s, int start, int end)
public boolean	Returns: true if the page written by this writer should be indexed, false otherwise isIndexable() Returns true if the page written by this writer should be indexed, false otherwise.
protected DocPath	pathString(TypeElement TypeElement for which the path is requested. te, DocPath Name of the file(doesn't include path). name) Return the path to the class page for a typeElement.
protected DocPath	pathString(PackageElement Package in which the file name is assumed to be. packageElement, DocPath File name, to which path string is. name) Return path to the given file name in the given package.
public void	printHtmlDocument(List<String> Array of String keywords for META tag. Each element of the array is assigned to a separate META tag. Pass in null for no array metakeywords, String the content for the description META tag. description, Content the body htmltree to be included in the document body) Generates the HTML document tree and prints it out.
public void	printHtmlDocument(List<String> Array of String keywords for META tag. Each element of the array is assigned to a separate META tag. Pass in null for no array metakeywords, String the content for the description META tag. description, List<DocPath> local stylesheets to be included in the HEAD element localStylesheets, Content the body htmltree to be included in the document body) Generates the HTML document tree and prints it out.
public void	printHtmlDocument(List<String> Array of String keywords for META tag. Each element of the array is assigned to a separate META tag. Pass in null for no array metakeywords, String the content for the description META tag. description, Content any additional content to be included in the HEAD element extraHeadContent, List<DocPath> local stylesheets to be included in the HEAD element localStylesheets, Content the body htmltree to be included in the document body) Generates the HTML document tree and prints it out.
private String	Returns: the text, with all the relative links redirected to work. redirectRelativeLinks(Element the Element object whose documentation is being written. element, TextTree the text being written. tt) Suppose a piece of documentation has a relative link.
public String	replaceDocRootDir(String htmlstr) Replace {@docRoot} tag used in options that accept HTML text, such as -header, -footer, -top and -bottom, and when converting a relative HREF where commentTagsToString inserts a {@docRoot} where one was missing.
public URI	resolveExternalSpecURI(URI specURI)
private boolean	Returns: true if a relative link should be redirected. shouldRedirectRelativeLinks(Element element) Returns true if relative links should be redirected.
private Content	withLinks(String key, String className, Set<TypeElement> elements)
private Content	withPreviewFeatures(String key, String className, String featureName, List<String> features)
protected final void	writeGenerating() Writes a "Generating _file_" message to the console

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

public abstract Class HtmlDocletWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary