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

Modifier and Type	Field and Description
pack-priv final NestedClassWriter	classSubWriter
pack-priv final ConstructorWriter	constrSubWriter
pack-priv final FieldWriter	fieldSubWriter
pack-priv final MethodWriter	methodSubWriter
pack-priv final SortedSet<PackageElement>	pkgSet
pack-priv final Map<PackageElement, List<Element>>	pkgToClassAnnotations
pack-priv final Map<PackageElement, List<Element>>	pkgToClassTypeParameter
pack-priv final Map<PackageElement, List<Element>>	pkgToConstructorAnnotations
pack-priv final Map<PackageElement, List<Element>>	pkgToConstructorArgs
pack-priv final Map<PackageElement, List<Element>>	pkgToConstructorArgTypeParameter
pack-priv final Map<PackageElement, List<Element>>	pkgToConstructorParameterAnnotations
pack-priv final Map<PackageElement, List<Element>>	pkgToConstructorThrows
pack-priv final Map<PackageElement, List<Element>>	pkgToField
pack-priv final Map<PackageElement, List<Element>>	pkgToFieldAnnotations
pack-priv final Map<PackageElement, List<Element>>	pkgToFieldTypeParameter
pack-priv final Map<PackageElement, List<Element>>	pkgToImplementingClass
pack-priv final Map<PackageElement, List<Element>>	pkgToImplementsTypeParameter
pack-priv final Map<PackageElement, List<Element>>	pkgToMethodAnnotations
pack-priv final Map<PackageElement, List<Element>>	pkgToMethodArgs
pack-priv final Map<PackageElement, List<Element>>	pkgToMethodArgTypeParameter
pack-priv final Map<PackageElement, List<Element>>	pkgToMethodParameterAnnotations
pack-priv final Map<PackageElement, List<Element>>	pkgToMethodReturn
pack-priv final Map<PackageElement, List<Element>>	pkgToMethodReturnTypeParameter
pack-priv final Map<PackageElement, List<Element>>	pkgToMethodThrows
pack-priv final Map<PackageElement, List<Element>>	pkgToMethodTypeParameter
pack-priv Set<PackageElement>	pkgToPackageAnnotations
pack-priv final Map<PackageElement, List<Element>>	pkgToSubclass
pack-priv final Map<PackageElement, List<Element>>	pkgToSubclassTypeParameter
pack-priv final Map<PackageElement, List<Element>>	pkgToSubinterface
pack-priv final Map<PackageElement, List<Element>>	pkgToSubinterfaceTypeParameter
pack-priv final TypeElement	typeElement

Access	Constructor and Description
public	ClassUseWriter(HtmlConfiguration the configuration configuration, ClassUseMapper a "mapper" containing the usage information mapper, TypeElement the type element typeElement) Creates a writer for a page listing the uses of a type element.

Method Summary

Modifier and Type	Method and Description
protected void	addClassList(Content the content to which the class elements will be added content) Add the class elements that use the given class.
protected void	addClassUse(Content the content to which the class use information will be added content) Add the class use documentation.
protected void	addClassUse(PackageElement the package that uses the given class pkg, Content the content to which the class use information will be added content) Add the class use information.
protected void	addPackageAnnotationList(Content the content to which the package annotation elements will be added content) Add the package annotation elements.
protected void	addPackageList(Content the content to which the packages elements will be added content) Add the packages elements that use the given class.
protected void	addPackageUse(PackageElement the package that uses the given class pkg, Table<?> the table to which the package use information will be added table) Add the package use information.
public void	buildPage() Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. Generate the class use elements.
public static void	generate(HtmlConfiguration the configuration for this doclet configuration, ClassTree the class tree hierarchy classTree) Write out class use and package use pages.
protected HtmlTree	Returns: the class use header getClassUseHeader() Get the header for the class use listing.
private static DocPath	pathFor(HtmlConfiguration configuration, TypeElement typeElement)
private Map<PackageElement, List<Element>>	pkgDivide(Map<TypeElement, ? extends List<? extends Element>> classMap)

Field Detail

classSubWriter	back to summary
pack-priv final NestedClassWriter classSubWriter

constrSubWriter	back to summary
pack-priv final ConstructorWriter constrSubWriter

fieldSubWriter	back to summary
pack-priv final FieldWriter fieldSubWriter

methodSubWriter	back to summary
pack-priv final MethodWriter methodSubWriter

pkgSet	back to summary
pack-priv final SortedSet<PackageElement> pkgSet

pkgToClassAnnotations	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToClassAnnotations

pkgToClassTypeParameter	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToClassTypeParameter

pkgToConstructorAnnotations	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToConstructorAnnotations

pkgToConstructorArgs	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToConstructorArgs

pkgToConstructorArgTypeParameter	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToConstructorArgTypeParameter

pkgToConstructorParameterAnnotations	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToConstructorParameterAnnotations

pkgToConstructorThrows	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToConstructorThrows

pkgToField	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToField

pkgToFieldAnnotations	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToFieldAnnotations

pkgToFieldTypeParameter	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToFieldTypeParameter

pkgToImplementingClass	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToImplementingClass

pkgToImplementsTypeParameter	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToImplementsTypeParameter

pkgToMethodAnnotations	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToMethodAnnotations

pkgToMethodArgs	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToMethodArgs

pkgToMethodArgTypeParameter	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToMethodArgTypeParameter

pkgToMethodParameterAnnotations	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToMethodParameterAnnotations

pkgToMethodReturn	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToMethodReturn

pkgToMethodReturnTypeParameter	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToMethodReturnTypeParameter

pkgToMethodThrows	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToMethodThrows

pkgToMethodTypeParameter	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToMethodTypeParameter

pkgToPackageAnnotations	back to summary
pack-priv Set<PackageElement> pkgToPackageAnnotations

pkgToSubclass	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToSubclass

pkgToSubclassTypeParameter	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToSubclassTypeParameter

pkgToSubinterface	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToSubinterface

pkgToSubinterfaceTypeParameter	back to summary
pack-priv final Map<PackageElement, List<Element>> pkgToSubinterfaceTypeParameter

typeElement	back to summary
pack-priv final TypeElement typeElement

Constructor Detail

ClassUseWriter	back to summary
public ClassUseWriter(HtmlConfiguration configuration, ClassUseMapper mapper, TypeElement typeElement) Creates a writer for a page listing the uses of a type element. Parameters configuration:HtmlConfiguration the configuration mapper:ClassUseMapper a "mapper" containing the usage information typeElement:TypeElement the type element

ClassUseWriter

back to summary

public ClassUseWriter(HtmlConfiguration configuration, ClassUseMapper mapper, TypeElement typeElement)

Creates a writer for a page listing the uses of a type element.

Parameters

configuration:HtmlConfiguration: the configuration
mapper:ClassUseMapper: a "mapper" containing the usage information
typeElement:TypeElement: the type element

Method Detail

addClassList	back to summary
protected void addClassList(Content content) Add the class elements that use the given class. Parameters content:Content the content to which the class elements will be added

addClassList

back to summary

protected void addClassList(Content content)

Add the class elements that use the given class.

Parameters

content:Content: the content to which the class elements will be added

addClassUse	back to summary
protected void addClassUse(Content content) Add the class use documentation. Parameters content:Content the content to which the class use information will be added

addClassUse

back to summary

protected void addClassUse(Content content)

Add the class use documentation.

Parameters

content:Content: the content to which the class use information will be added

addClassUse	back to summary
protected void addClassUse(PackageElement pkg, Content content) Add the class use information. Parameters pkg:PackageElement the package that uses the given class content:Content the content to which the class use information will be added

addClassUse

back to summary

protected void addClassUse(PackageElement pkg, Content content)

Add the class use information.

Parameters

pkg:PackageElement: the package that uses the given class
content:Content: the content to which the class use information will be added

addPackageAnnotationList	back to summary
protected void addPackageAnnotationList(Content content) Add the package annotation elements. Parameters content:Content the content to which the package annotation elements will be added

addPackageAnnotationList

back to summary

protected void addPackageAnnotationList(Content content)

Add the package annotation elements.

Parameters

content:Content: the content to which the package annotation elements will be added

addPackageList	back to summary
protected void addPackageList(Content content) Add the packages elements that use the given class. Parameters content:Content the content to which the packages elements will be added

addPackageList

back to summary

protected void addPackageList(Content content)

Add the packages elements that use the given class.

Parameters

content:Content: the content to which the packages elements will be added

addPackageUse	back to summary
protected void addPackageUse(PackageElement pkg, Table<?> table) Add the package use information. Parameters pkg:PackageElement the package that uses the given class table:Table<?> the table to which the package use information will be added

addPackageUse

back to summary

protected void addPackageUse(PackageElement pkg, Table<?> table)

Add the package use information.

Parameters

pkg:PackageElement: the package that uses the given class
table:Table<?>: the table to which the package use information will be added

buildPage	back to summary
public void buildPage() throws DocFileIOException Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. Generate the class use elements. Annotations @Override Exceptions DocFileIOException: if there is a problem while generating the documentation

buildPage

back to summary

public void buildPage() throws DocFileIOException

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

Generate the class use elements.

Annotations

@Override

Exceptions

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

generate	back to summary
public static void generate(HtmlConfiguration configuration, ClassTree classTree) throws DocletException Write out class use and package use pages. Parameters configuration:HtmlConfiguration the configuration for this doclet classTree:ClassTree the class tree hierarchy Exceptions DocletException: if there is an error while generating the documentation

generate

back to summary

public static void generate(HtmlConfiguration configuration, ClassTree classTree) throws DocletException

Write out class use and package use pages.

Parameters

configuration:HtmlConfiguration: the configuration for this doclet
classTree:ClassTree: the class tree hierarchy

Exceptions

DocletException:: if there is an error while generating the documentation

getClassUseHeader	back to summary
protected HtmlTree getClassUseHeader() Get the header for the class use listing. Returns:HtmlTree the class use header

getClassUseHeader

back to summary

protected HtmlTree getClassUseHeader()

Get the header for the class use listing.

Returns:HtmlTree: the class use header

pathFor	back to summary
private static DocPath pathFor(HtmlConfiguration configuration, TypeElement typeElement)

pkgDivide	back to summary
private Map<PackageElement, List<Element>> pkgDivide(Map<TypeElement, ? extends List<? extends Element>> classMap)

public Class ClassUseWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail