APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.toolkit

public Class OverviewElement

extends Object
implements DocletElement
Class Inheritance
All Implemented Interfaces
jdk.javadoc.internal.doclets.toolkit.DocletElement, javax.lang.model.element.Element, javax.lang.model.AnnotatedConstruct
Imports
javax.lang.model.element.PackageElement, javax.tools.FileObject
This is a pseudo element wrapper for the overview element, essentially to associate overview documentation's DocCommentTree to this element.

Field Summary

Modifier and TypeField and Description
private final FileObject
fo

private final PackageElement
pkg

Constructor Summary

AccessConstructor and Description
public
OverviewElement(PackageElement pkg, FileObject fo)

Method Summary

Modifier and TypeMethod and Description
public FileObject
getFileObject()

Implements jdk.javadoc.internal.doclets.toolkit.DocletElement.getFileObject.

Returns the file object associated with this special element such as overview.html, doc-files/foo.html.

public PackageElement
getPackageElement()

Implements jdk.javadoc.internal.doclets.toolkit.DocletElement.getPackageElement.

Returns the anchoring package element, in the case of a module element, this is the module's unnamed package.

public DocletElement.Kind
getSubKind()

Implements jdk.javadoc.internal.doclets.toolkit.DocletElement.getSubKind.

Returns the subkind of this element.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

foback to summary
private final FileObject fo
pkgback to summary
private final PackageElement pkg

Constructor Detail

OverviewElementback to summary
public OverviewElement(PackageElement pkg, FileObject fo)

Method Detail

getFileObjectback to summary
public FileObject getFileObject()

Implements jdk.javadoc.internal.doclets.toolkit.DocletElement.getFileObject.

Doc from jdk.javadoc.internal.doclets.toolkit.DocletElement.getFileObject.

Returns the file object associated with this special element such as overview.html, doc-files/foo.html.

Annotations
@Override
getPackageElementback to summary
public PackageElement getPackageElement()

Implements jdk.javadoc.internal.doclets.toolkit.DocletElement.getPackageElement.

Doc from jdk.javadoc.internal.doclets.toolkit.DocletElement.getPackageElement.

Returns the anchoring package element, in the case of a module element, this is the module's unnamed package.

Annotations
@Override
getSubKindback to summary
public DocletElement.Kind getSubKind()

Implements jdk.javadoc.internal.doclets.toolkit.DocletElement.getSubKind.

Doc from jdk.javadoc.internal.doclets.toolkit.DocletElement.getSubKind.

Returns the subkind of this element.

Annotations
@Override