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

Modifier and Type	Field and Description
pack-priv final PackageElement	packageElement
pack-priv final SortedMap<String, Set<TypeElement>>	usingPackageToUsedClasses

Access	Constructor and Description
public	PackageUseWriter(HtmlConfiguration the configuration configuration, ClassUseMapper a mapper to provide details of where elements are used mapper, PackageElement the package element to be documented pkgElement) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addClassList(Content the content to which the class list will be added content) Add the list of classes that use the given package.
protected void	addPackageList(Content the content to which the package list will be added content) Add the list of packages that use the given package.
protected void	addPackageUse(Content the content to which the package use information will be added content) Add the package use information.
public void	buildPage() Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. Generate the package use list.
private HtmlTree	Returns: the package use HTML BODY element getBody() Returns the package use HTML BODY element.
private static DocPath	pathFor(HtmlConfiguration configuration, PackageElement packageElement)

packageElement	back to summary
pack-priv final PackageElement packageElement

usingPackageToUsedClasses	back to summary
pack-priv final SortedMap<String, Set<TypeElement>> usingPackageToUsedClasses

PackageUseWriter	back to summary
public PackageUseWriter(HtmlConfiguration configuration, ClassUseMapper mapper, PackageElement pkgElement) Constructor. Parameters configuration:HtmlConfiguration the configuration mapper:ClassUseMapper a mapper to provide details of where elements are used pkgElement:PackageElement the package element to be documented

PackageUseWriter

public PackageUseWriter(HtmlConfiguration configuration, ClassUseMapper mapper, PackageElement pkgElement)

Constructor.

Parameters

configuration:HtmlConfiguration: the configuration
mapper:ClassUseMapper: a mapper to provide details of where elements are used
pkgElement:PackageElement: the package element to be documented

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

addClassList

protected void addClassList(Content content)

Add the list of classes that use the given package.

Parameters

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

addPackageList

protected void addPackageList(Content content)

Add the list of packages that use the given package.

Parameters

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

addPackageUse

protected void addPackageUse(Content content)

Add the package use information.

Parameters

content:Content: the content 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 package use list. Annotations @Override Exceptions DocFileIOException: if there is a problem generating the package use page

buildPage

public void buildPage() throws DocFileIOException

Generate the package use list.

Annotations