OpenJDK 27 · jdk.javadoc.internal.doclets.toolkit.DocFileElement

Modifier and Type	Field and Description
private final Element	element
private final FileObject	fo
private final PackageElement	packageElement

Access	Constructor and Description
public	DocFileElement(Utils the standard utilities class utils, Element the module element or package element that "owns" the `doc-files` subdirectory element, FileObject the file object fo) Creates a pseudo-element that wraps a `doc-files` documentation file.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides java.lang.Object.equals. Implements javax.lang.model.element.Element.equals. Returns `true` if the argument represents the same element as `this`, or `false` otherwise.
public Element	Returns: the element that "owns" the `doc-files` directory getElement() Returns the element that "owns" the `doc-files` directory.
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.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements javax.lang.model.element.Element.hashCode. Obeys the general contract of `Object.hashCode`.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

element	back to summary
private final Element element

fo	back to summary
private final FileObject fo

packageElement	back to summary
private final PackageElement packageElement

Constructor Detail

DocFileElement back to summary

DocFileElement	back to summary
public DocFileElement(Utils utils, Element element, FileObject fo) Creates a pseudo-element that wraps a `doc-files` documentation file. Parameters utils:Utils the standard utilities class element:Element the module element or package element that "owns" the `doc-files` subdirectory fo:FileObject the file object Exceptions IllegalArgumentException: if the given element is not a module element or package element

public DocFileElement(Utils utils, Element element, FileObject fo)

Creates a pseudo-element that wraps a doc-files documentation file.

Parameters

utils:Utils: the standard utilities class
element:Element: the module element or package element that "owns" the doc-files subdirectory
fo:FileObject: the file object

Exceptions

IllegalArgumentException:: if the given element is not a module element or package element

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Implements javax.lang.model.element.Element.equals. Doc from javax.lang.model.element.Element.equals. Returns `true` if the argument represents the same element as `this`, or `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Implements javax.lang.model.element.Element.equals.

Doc from javax.lang.model.element.Element.equals.

Returns true if the argument represents the same element as this, or false otherwise.

Annotations

@Override

getElement back to summary

getElement	back to summary
public Element getElement() Returns the element that "owns" the `doc-files` directory. Returns:Element the element that "owns" the `doc-files` directory

public Element getElement()

Returns the element that "owns" the doc-files directory.

Returns:Element: the element that "owns" the doc-files directory

getFileObject back to summary

getFileObject	back 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

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

getPackageElement	back 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

getPackageElement

back 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

getSubKind	back 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

getSubKind

back 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

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements javax.lang.model.element.Element.hashCode. Doc from javax.lang.model.element.Element.hashCode. Obeys the general contract of `Object.hashCode`. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements javax.lang.model.element.Element.hashCode.

Doc from javax.lang.model.element.Element.hashCode.

Obeys the general contract of Object.hashCode.

Annotations

@Override

public Class DocFileElement

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail