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

Modifier and Type	Field and Description
protected final ClassTree	classTree The class and interface tree built by using `ClassTree`

Constructor Summary

Access	Constructor and Description
protected	AbstractTreeWriter(HtmlConfiguration The current configuration configuration, DocPath File to be generated. filename, ClassTree Tree built by `ClassTree`. classTree) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addExtendsImplements(TypeElement the parent class of the class being documented parent, TypeElement the TypeElement under consideration typeElement, Content the content to which the information will be added content) Add information regarding the classes which this class extends or implements.
protected void	addLevelInfo(TypeElement the superclass or superinterface of the sset parent, Collection<TypeElement> a collection of the subclasses at this level collection, ClassTree.Hierarchy the hierarchy for which we are generating a tree hierarchy, Content the content to which the level information will be added content) Add each level of the class tree.
protected void	addPartialInfo(TypeElement the class being documented typeElement, Content the content to which the information will be added content) Add information about the class kind, if it's a "class" or "interface".
protected void	addTree(ClassTree.Hierarchy the hierarchy to add hierarchy, String the heading heading, Content the content to which to add the hierarchy content) Adds a class or interface hierarchy with a given heading to given content.

Inherited from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter:: addInlineComment addInlineComment addInlineDeprecatedComment addPreQualifiedClassLink addPreQualifiedClassLink addPreQualifiedStrongClassLink addPreviewComment addPreviewInfo addPreviewSummary addRestrictedInfo addRestrictedSummary addSrcLink addSummaryComment addSummaryComment addSummaryDeprecatedComment addTagsInfo buildPage commentTagsToContent commentTagsToContent commentTagsToContent createTableOfContents getAnnotationInfo getAnnotationInfo getAnnotations getBlockTagOutput getBlockTagOutput getBody getBodyStyle getCrossClassLink getCrossModuleLink getCrossPackageLink getCurrentTypeElement getDeprecatedPhrase getDescription getDocLink getDocLink getDocLink getDocLink getDocLink getEnclosingPackageName getFileTitle getFooter getGenerator getHeader getHeader getLink getLocalizedPackageName getLocalStylesheets getModuleLink getModuleLink getNavBar getNavLinkToOverviewTree getPackageLabel getPackageLink getPackageLink getPackageTableHeader getPreQualifiedClassLink getQualifiedClassLink getTagletWriterInstance getTagletWriterInstance getTypeParameterLinks getWindowTitle hasSerializationOverviewTags ignoreNonInlineTag invalidTagOutput isIndexable pathString pathString printHtmlDocument printHtmlDocument printHtmlDocument replaceDocRootDir resolveExternalSpecURI writeGenerating

Field Detail

classTree	back to summary
protected final ClassTree classTree The class and interface tree built by using `ClassTree`

Constructor Detail

AbstractTreeWriter back to summary

AbstractTreeWriter	back to summary
protected AbstractTreeWriter(HtmlConfiguration configuration, DocPath filename, ClassTree classTree) Constructor. This constructor will be used while generating global tree file "overview-tree.html". Parameters configuration:HtmlConfiguration The current configuration filename:DocPath File to be generated. classTree:ClassTree Tree built by `ClassTree`.

protected AbstractTreeWriter(HtmlConfiguration configuration, DocPath filename, ClassTree classTree)

Constructor. This constructor will be used while generating global tree file "overview-tree.html".

Parameters

configuration:HtmlConfiguration: The current configuration
filename:DocPath: File to be generated.
classTree:ClassTree: Tree built by ClassTree.

Method Detail

addExtendsImplements	back to summary
protected void addExtendsImplements(TypeElement parent, TypeElement typeElement, Content content) Add information regarding the classes which this class extends or implements. Parameters parent:TypeElement the parent class of the class being documented typeElement:TypeElement the TypeElement under consideration content:Content the content to which the information will be added

addExtendsImplements

back to summary

protected void addExtendsImplements(TypeElement parent, TypeElement typeElement, Content content)

Add information regarding the classes which this class extends or implements.

Parameters

parent:TypeElement: the parent class of the class being documented
typeElement:TypeElement: the TypeElement under consideration
content:Content: the content to which the information will be added

addLevelInfo	back to summary
protected void addLevelInfo(TypeElement parent, Collection<TypeElement> collection, ClassTree.Hierarchy hierarchy, Content content) Add each level of the class tree. For each subclass or subinterface indents the next level information. Recurses itself to add subclasses info. Parameters parent:TypeElement the superclass or superinterface of the sset collection:Collection<TypeElement> a collection of the subclasses at this level hierarchy:ClassTree.Hierarchy the hierarchy for which we are generating a tree content:Content the content to which the level information will be added

addLevelInfo

back to summary

protected void addLevelInfo(TypeElement parent, Collection<TypeElement> collection, ClassTree.Hierarchy hierarchy, Content content)

Add each level of the class tree. For each subclass or subinterface indents the next level information. Recurses itself to add subclasses info.

Parameters

parent:TypeElement: the superclass or superinterface of the sset
collection:Collection<TypeElement>: a collection of the subclasses at this level
hierarchy:ClassTree.Hierarchy: the hierarchy for which we are generating a tree
content:Content: the content to which the level information will be added

addPartialInfo	back to summary
protected void addPartialInfo(TypeElement typeElement, Content content) Add information about the class kind, if it's a "class" or "interface". Parameters typeElement:TypeElement the class being documented content:Content the content to which the information will be added

addPartialInfo

back to summary

protected void addPartialInfo(TypeElement typeElement, Content content)

Add information about the class kind, if it's a "class" or "interface".

Parameters

typeElement:TypeElement: the class being documented
content:Content: the content to which the information will be added

addTree	back to summary
protected void addTree(ClassTree.Hierarchy hierarchy, String heading, Content content) Adds a class or interface hierarchy with a given heading to given content. Parameters hierarchy:ClassTree.Hierarchy the hierarchy to add heading:String the heading content:Content the content to which to add the hierarchy

addTree

back to summary

protected void addTree(ClassTree.Hierarchy hierarchy, String heading, Content content)

Adds a class or interface hierarchy with a given heading to given content.

Parameters

hierarchy:ClassTree.Hierarchy: the hierarchy to add
heading:String: the heading
content:Content: the content to which to add the hierarchy

public abstract Class AbstractTreeWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail