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

Modifier and Type	Field and Description
protected final ClassTree	classTree
protected static final int	LONG_TYPE_PARAM
protected final PropertyUtils.PropertyHelper	pHelper
private static final Set<String>	suppressImplementingSet
private static final Set<String>	suppressSubtypesSet
protected final TypeElement	typeElement

Access	Constructor and Description
public	ClassWriter(HtmlConfiguration the configuration data for the doclet configuration, TypeElement the class being documented. typeElement, ClassTree the class tree for the given class. classTree)

Method Summary

Modifier and Type	Method and Description
protected void	addClassDeprecationInfo(Content classInfo)
protected void	addClassDescription(Content classInfo)
protected void	addClassSignature(Content classInfo)
protected void	addClassTagInfo(Content classInfo)
protected void	addClassTree(Content target)
protected void	addFooter()
protected void	addFunctionalInterfaceInfo(Content target)
protected void	addImplementedInterfacesInfo(Content target)
protected void	addInterfaceUsageInfo(Content target)
protected void	addNestedClassInfo(final Content target)
protected void	addParamInfo(Content target)
private void	addPreviewInfo(Content content)
protected void	addSubClassInfo(Content target)
protected void	addSubInterfacesInfo(Content target)
protected void	addSuperInterfacesInfo(Content target)
protected void	buildClassDescription(Content the content to which the documentation will be added target) Build the class description.
protected void	buildClassDoc() Handles the <TypeElement> tag.
protected void	buildClassInfo(Content the content to which the documentation will be added target) Build the class information documentation.
protected void	buildClassSignature(Content the content to which the documentation will be added target) Build the signature of the current class.
protected void	buildClassTagInfo(Content the content to which the documentation will be added target) Build the tag information for the current class.
protected void	buildClassTree(Content the content to which the documentation will be added classContent) Build the class inheritance tree documentation.
protected void	buildDeprecationInfo(Content the content to which the documentation will be added target) If this class is deprecated, build the appropriate information.
protected void	buildFunctionalInterfaceInfo(Content the content to which the documentation will be added target) If this is a functional interface, display appropriate message.
protected void	buildImplementedInterfacesInfo(Content the content to which the documentation will be added target) If this is a class, list all interfaces implemented by this class.
protected void	buildInterfaceUsageInfo(Content the content to which the documentation will be added target) If this is an interface, list all classes that implement this interface.
protected void	buildMemberDetails(Content the content to which the documentation will be added classContent) Build the member details contents of the page.
protected void	buildMemberSummary(Content the content to which the documentation will be added classContent) Build the member summary contents of the page.
protected void	buildNestedClassInfo(Content the content to which the documentation will be added target) If this is an inner class or interface, list the enclosing class or interface.
public void	buildPage() Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. The top-level method to generate and write the page represented by this writer.
protected void	buildParamInfo(Content the content to which the documentation will be added target) Build the type parameters and state components of this class.
protected void	buildSubClassInfo(Content the content to which the documentation will be added target) List all the classes that extend this one.
protected void	buildSubInterfacesInfo(Content the content to which the documentation will be added target) List all the interfaces that extend this one.
protected void	buildSuperInterfacesInfo(Content the content to which the documentation will be added target) If this is an interface, list all superinterfaces.
private void	copyDocFiles() Copy the doc files.
protected Content	getClassContentHeader()
private Content	Returns: the class helper getClassHelperContent(TypeMirror the class to get the helper for type) Get the class helper for the given class.
protected Content	getClassInfo(Content classInfo)
private Content	Returns: the class inheritance tree getClassInheritanceTreeContent(TypeMirror the class to get the inheritance tree for type) Get the class inheritance tree for the given class.
private Content	Returns: the links getClassLinks(HtmlLinkInfo.Kind the id of the context where the links will be added context, Collection<?> the classes list) Get the links to the given classes.
public TypeElement	getCurrentTypeElement() Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.getCurrentTypeElement. Returns the type element documented by this writer if it is a `ClassWriter`, or null for any other kind of writer.
protected Content	getHeader(String header)
protected Content	getMemberDetails(Content content)
public PropertyUtils.PropertyHelper	getPropertyHelper() Overrides jdk.javadoc.internal.doclets.formats.html.SubWriterHolderWriter.getPropertyHelper.
public TypeElement	Returns: the TypeElement being documented. getTypeElement() Return the TypeElement being documented.
private Content	getTypeParameters()
public boolean	isIndexable() Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable. Returns true if the page written by this writer should be indexed, false otherwise.
protected void	printDocument(Content content)
private void	setEnumDocumentation(TypeElement the enum element elem) The documentation for values() and valueOf() in Enums are set by the doclet only iff the user or overridden methods are missing.
private void	setRecordDocumentation(TypeElement the record element elem) Sets the documentation as needed for the mandated parts of a record type.

classTree	back to summary
protected final ClassTree classTree

LONG_TYPE_PARAM	back to summary
protected static final int LONG_TYPE_PARAM

pHelper	back to summary
protected final PropertyUtils.PropertyHelper pHelper

suppressImplementingSet	back to summary
private static final Set<String> suppressImplementingSet

suppressSubtypesSet	back to summary
private static final Set<String> suppressSubtypesSet

typeElement	back to summary
protected final TypeElement typeElement

ClassWriter	back to summary
public ClassWriter(HtmlConfiguration configuration, TypeElement typeElement, ClassTree classTree) Parameters configuration:HtmlConfiguration the configuration data for the doclet typeElement:TypeElement the class being documented. classTree:ClassTree the class tree for the given class.

Method Detail

addClassDeprecationInfo	back to summary
protected void addClassDeprecationInfo(Content classInfo)

addClassDescription	back to summary
protected void addClassDescription(Content classInfo)

addClassSignature	back to summary
protected void addClassSignature(Content classInfo)

addClassTagInfo	back to summary
protected void addClassTagInfo(Content classInfo)

addClassTree	back to summary
protected void addClassTree(Content target)

addFooter	back to summary
protected void addFooter()

addFunctionalInterfaceInfo	back to summary
protected void addFunctionalInterfaceInfo(Content target)

addImplementedInterfacesInfo	back to summary
protected void addImplementedInterfacesInfo(Content target)

addInterfaceUsageInfo	back to summary
protected void addInterfaceUsageInfo(Content target)

addNestedClassInfo	back to summary
protected void addNestedClassInfo(final Content target)

addParamInfo	back to summary
protected void addParamInfo(Content target)

addPreviewInfo	back to summary
private void addPreviewInfo(Content content)

addSubClassInfo	back to summary
protected void addSubClassInfo(Content target)

addSubInterfacesInfo	back to summary
protected void addSubInterfacesInfo(Content target)

addSuperInterfacesInfo	back to summary
protected void addSuperInterfacesInfo(Content target)

buildClassDescription	back to summary
protected void buildClassDescription(Content target) Build the class description. Parameters target:Content the content to which the documentation will be added

buildClassDescription

back to summary

protected void buildClassDescription(Content target)

Build the class description.

Parameters

target:Content: the content to which the documentation will be added

buildClassDoc	back to summary
protected void buildClassDoc() throws DocletException Handles the <TypeElement> tag. Exceptions DocletException: if there is a problem while building the documentation

buildClassDoc

back to summary

protected void buildClassDoc() throws DocletException

Handles the <TypeElement> tag.

Exceptions

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

buildClassInfo	back to summary
protected void buildClassInfo(Content target) Build the class information documentation. Parameters target:Content the content to which the documentation will be added

buildClassInfo

back to summary

protected void buildClassInfo(Content target)

Build the class information documentation.

Parameters

target:Content: the content to which the documentation will be added

buildClassSignature	back to summary
protected void buildClassSignature(Content target) Build the signature of the current class. Parameters target:Content the content to which the documentation will be added

buildClassSignature

back to summary

protected void buildClassSignature(Content target)

Build the signature of the current class.

Parameters

target:Content: the content to which the documentation will be added

buildClassTagInfo	back to summary
protected void buildClassTagInfo(Content target) Build the tag information for the current class. Parameters target:Content the content to which the documentation will be added

buildClassTagInfo

back to summary

protected void buildClassTagInfo(Content target)

Build the tag information for the current class.

Parameters

target:Content: the content to which the documentation will be added

buildClassTree	back to summary
protected void buildClassTree(Content classContent) Build the class inheritance tree documentation. Parameters classContent:Content the content to which the documentation will be added

buildClassTree

back to summary

protected void buildClassTree(Content classContent)

Build the class inheritance tree documentation.

Parameters

classContent:Content: the content to which the documentation will be added

buildDeprecationInfo	back to summary
protected void buildDeprecationInfo(Content target) If this class is deprecated, build the appropriate information. Parameters target:Content the content to which the documentation will be added

buildDeprecationInfo

back to summary

protected void buildDeprecationInfo(Content target)

If this class is deprecated, build the appropriate information.

Parameters

target:Content: the content to which the documentation will be added

buildFunctionalInterfaceInfo	back to summary
protected void buildFunctionalInterfaceInfo(Content target) If this is a functional interface, display appropriate message. Parameters target:Content the content to which the documentation will be added

buildFunctionalInterfaceInfo

back to summary

protected void buildFunctionalInterfaceInfo(Content target)

If this is a functional interface, display appropriate message.

Parameters

target:Content: the content to which the documentation will be added

buildImplementedInterfacesInfo	back to summary
protected void buildImplementedInterfacesInfo(Content target) If this is a class, list all interfaces implemented by this class. Parameters target:Content the content to which the documentation will be added

buildImplementedInterfacesInfo

back to summary

protected void buildImplementedInterfacesInfo(Content target)

If this is a class, list all interfaces implemented by this class.

Parameters

target:Content: the content to which the documentation will be added

buildInterfaceUsageInfo	back to summary
protected void buildInterfaceUsageInfo(Content target) If this is an interface, list all classes that implement this interface. Parameters target:Content the content to which the documentation will be added

buildInterfaceUsageInfo

back to summary

protected void buildInterfaceUsageInfo(Content target)

If this is an interface, list all classes that implement this interface.

Parameters

target:Content: the content to which the documentation will be added

buildMemberDetails	back to summary
protected void buildMemberDetails(Content classContent) Build the member details contents of the page. Parameters classContent:Content the content to which the documentation will be added

buildMemberDetails

back to summary

protected void buildMemberDetails(Content classContent)

Build the member details contents of the page.

Parameters

classContent:Content: the content to which the documentation will be added

buildMemberSummary	back to summary
protected void buildMemberSummary(Content classContent) Build the member summary contents of the page. Parameters classContent:Content the content to which the documentation will be added

buildMemberSummary

back to summary

protected void buildMemberSummary(Content classContent)

Build the member summary contents of the page.

Parameters

classContent:Content: the content to which the documentation will be added

buildNestedClassInfo	back to summary
protected void buildNestedClassInfo(Content target) If this is an inner class or interface, list the enclosing class or interface. Parameters target:Content the content to which the documentation will be added

buildNestedClassInfo

back to summary

protected void buildNestedClassInfo(Content target)

If this is an inner class or interface, list the enclosing class or interface.

Parameters

target:Content: the content to which the documentation will be added

buildPage	back to summary
public void buildPage() throws DocletException Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. The top-level method to generate and write the page represented by this writer. Annotations @Override Exceptions DocletException: if a problem occurs while building or writing the page

buildPage

back to summary

public void buildPage() throws DocletException

Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

The top-level method to generate and write the page represented by this writer.

Annotations

@Override

Exceptions

DocletException:: if a problem occurs while building or writing the page

buildParamInfo	back to summary
protected void buildParamInfo(Content target) Build the type parameters and state components of this class. Parameters target:Content the content to which the documentation will be added

buildParamInfo

back to summary

protected void buildParamInfo(Content target)

Build the type parameters and state components of this class.

Parameters

target:Content: the content to which the documentation will be added

buildSubClassInfo	back to summary
protected void buildSubClassInfo(Content target) List all the classes that extend this one. Parameters target:Content the content to which the documentation will be added

buildSubClassInfo

back to summary

protected void buildSubClassInfo(Content target)

List all the classes that extend this one.

Parameters

target:Content: the content to which the documentation will be added

buildSubInterfacesInfo	back to summary
protected void buildSubInterfacesInfo(Content target) List all the interfaces that extend this one. Parameters target:Content the content to which the documentation will be added

buildSubInterfacesInfo

back to summary

protected void buildSubInterfacesInfo(Content target)

List all the interfaces that extend this one.

Parameters

target:Content: the content to which the documentation will be added

buildSuperInterfacesInfo	back to summary
protected void buildSuperInterfacesInfo(Content target) If this is an interface, list all superinterfaces. Parameters target:Content the content to which the documentation will be added

buildSuperInterfacesInfo

back to summary

protected void buildSuperInterfacesInfo(Content target)

If this is an interface, list all superinterfaces.

Parameters

target:Content: the content to which the documentation will be added

copyDocFiles	back to summary
private void copyDocFiles() throws DocletException Copy the doc files. Exceptions DocFileIOException: if there is a problem while copying the files

copyDocFiles

back to summary

private void copyDocFiles() throws DocletException

Copy the doc files.

Exceptions

DocFileIOException:: if there is a problem while copying the files

getClassContentHeader	back to summary
protected Content getClassContentHeader()

getClassHelperContent	back to summary
private Content getClassHelperContent(TypeMirror type) Get the class helper for the given class. Parameters type:TypeMirror the class to get the helper for Returns:Content the class helper

getClassHelperContent

back to summary

private Content getClassHelperContent(TypeMirror type)

Get the class helper for the given class.

Parameters

type:TypeMirror: the class to get the helper for

Returns:Content

the class helper

getClassInfo	back to summary
protected Content getClassInfo(Content classInfo)

getClassInheritanceTreeContent	back to summary
private Content getClassInheritanceTreeContent(TypeMirror type) Get the class inheritance tree for the given class. Parameters type:TypeMirror the class to get the inheritance tree for Returns:Content the class inheritance tree

getClassInheritanceTreeContent

back to summary

private Content getClassInheritanceTreeContent(TypeMirror type)

Get the class inheritance tree for the given class.

Parameters

type:TypeMirror: the class to get the inheritance tree for

Returns:Content

the class inheritance tree

getClassLinks	back to summary
private Content getClassLinks(HtmlLinkInfo.Kind context, Collection<?> list) Get the links to the given classes. Parameters context:HtmlLinkInfo.Kind the id of the context where the links will be added list:Collection<?> the classes Returns:Content the links

getClassLinks

back to summary

private Content getClassLinks(HtmlLinkInfo.Kind context, Collection<?> list)

Get the links to the given classes.

Parameters

context:HtmlLinkInfo.Kind: the id of the context where the links will be added
list:Collection<?>: the classes

Returns:Content

the links

getCurrentTypeElement back to summary

getCurrentTypeElement	back to summary
public TypeElement getCurrentTypeElement() Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.getCurrentTypeElement. Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.getCurrentTypeElement. Returns the type element documented by this writer if it is a `ClassWriter`, or null for any other kind of writer. Annotations @Override

public TypeElement getCurrentTypeElement()

Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.getCurrentTypeElement.

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.getCurrentTypeElement.

Returns the type element documented by this writer if it is a ClassWriter, or null for any other kind of writer.

Annotations

@Override

getHeader	back to summary
protected Content getHeader(String header)

getMemberDetails	back to summary
protected Content getMemberDetails(Content content)

getPropertyHelper

back to summary

public PropertyUtils.PropertyHelper getPropertyHelper()

Overrides jdk.javadoc.internal.doclets.formats.html.SubWriterHolderWriter.getPropertyHelper.

Annotations

@Override

getTypeElement

back to summary

public TypeElement getTypeElement()

Return the TypeElement being documented.

Returns:TypeElement: the TypeElement being documented.

getTypeParameters	back to summary
private Content getTypeParameters()

isIndexable

back to summary

public boolean isIndexable()

Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable.

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable.

Returns true if the page written by this writer should be indexed, false otherwise. Some pages merely aggregate filtered information available on other pages and, thus, have no indexing value. In fact, if indexed, they would clutter the index and mislead the reader.

Annotations

@Override

printDocument	back to summary
protected void printDocument(Content content) throws DocFileIOException

setEnumDocumentation

back to summary

private void setEnumDocumentation(TypeElement elem)

The documentation for values() and valueOf() in Enums are set by the doclet only iff the user or overridden methods are missing.

Parameters

elem:TypeElement: the enum element

setRecordDocumentation back to summary

private void setRecordDocumentation(TypeElement elem)

Sets the documentation as needed for the mandated parts of a record type. This includes the canonical constructor, methods like equals, hashCode, toString, the accessor methods, and the underlying field.

Parameters

elem:TypeElement: the record element

public Class ClassWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail