APIdia Launch Partner
Top Description Inners Methods
jdk.javadoc.internal.doclets.formats.html.taglets

public Interface InheritableTaglet

Known Direct Implementers
jdk.javadoc.internal.doclets.formats.html.taglets.ParamTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.ReturnTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.SeeTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.SimpleTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.SpecTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.ThrowsTaglet
Imports
java.util.List, javax.lang.model.element.Element, com.sun.source.doctree.DocTree
A taglet should implement this interface if it supports an {@inheritDoc} tag or is automatically inherited if it is missing.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static record
InheritableTaglet.Output

Method Summary

Modifier and TypeMethod and Description
public InheritableTaglet.Output
inherit(Element dst, Element src, DocTree tag, boolean isFirstSentence)

Method Detail

inheritback to summary
public InheritableTaglet.Output inherit(Element dst, Element src, DocTree tag, boolean isFirstSentence)
jdk.javadoc.internal.doclets.formats.html.taglets back to summary

public final Record InheritableTaglet.Output

extends Record
Class Inheritance
Record Components
holderTag:DocTree 
holder:Element 
inlineTags:List<? extends DocTree> 
isValidInheritDocTag:boolean 

Field Summary

Modifier and TypeField and Description
private final Element
holder

Record Component accessed by holder().

private final DocTree
holderTag

Record Component accessed by holderTag().

private final List<? extends DocTree>
inlineTags

Record Component accessed by inlineTags().

private final boolean
isValidInheritDocTag

Record Component accessed by isValidInheritDocTag().

Constructor Summary

AccessConstructor and Description
public
Output(DocTree holderTag, Element holder, List<? extends DocTree> inlineTags, boolean isValidInheritDocTag)

Method Summary

Modifier and TypeMethod and Description
public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public Element
holder()

Record Component getter of holder.

public DocTree
holderTag()

Record Component getter of holderTag.

public List<? extends DocTree>
inlineTags()

Record Component getter of inlineTags.

public boolean
isValidInheritDocTag()

Record Component getter of isValidInheritDocTag.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

holderback to summary
private final Element holder

Record Component accessed by holder().

holderTagback to summary
private final DocTree holderTag

Record Component accessed by holderTag().

inlineTagsback to summary
private final List<? extends DocTree> inlineTags

Record Component accessed by inlineTags().

isValidInheritDocTagback to summary
private final boolean isValidInheritDocTag

Record Component accessed by isValidInheritDocTag().

Constructor Detail

Outputback to summary
public Output(DocTree holderTag, Element holder, List<? extends DocTree> inlineTags, boolean isValidInheritDocTag)

Method Detail

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: 

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

holderback to summary
public Element holder()

Record Component getter of holder.

holderTagback to summary
public DocTree holderTag()

Record Component getter of holderTag.

inlineTagsback to summary
public List<? extends DocTree> inlineTags()

Record Component getter of inlineTags.

isValidInheritDocTagback to summary
public boolean isValidInheritDocTag()

Record Component getter of isValidInheritDocTag.

toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.