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

public Class SpecTaglet

extends BaseTaglet
implements InheritableTaglet
Class Inheritance
All Implemented Interfaces
jdk.javadoc.internal.doclets.formats.html.taglets.InheritableTaglet
Imports
java.net.URI, .URISyntaxException, java.util.EnumSet, .List, .Optional, javax.lang.model.element.Element, .ExecutableElement, com.sun.source.doctree.DocTree, .SpecTree, com.sun.source.util.DocTreePath, jdk.javadoc.doclet.Taglet, jdk.javadoc.internal.doclets.formats.html.Contents, .HtmlConfiguration, jdk.javadoc.internal.doclets.toolkit.util.CommentHelper, .DocFinder, .Utils, jdk.javadoc.internal.html.Content, .ContentBuilder, .HtmlTree, .Text
A taglet that represents the @spec tag.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static record
SpecTaglet.Documentation

Field Summary

Modifier and TypeField and Description
private final Contents
contents

Inherited from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet:
configmessagesnameresourcestagKindtagletWriterutils

Constructor Summary

AccessConstructor and Description
pack-priv
SpecTaglet(HtmlConfiguration config)

Method Summary

Modifier and TypeMethod and Description
private static Optional<SpecTaglet.Documentation>
extract(Utils utils, ExecutableElement method)

public Content
getAllBlockTagOutput(Element holder, TagletWriter tagletWriter)

Overrides jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getAllBlockTagOutput.

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getAllBlockTagOutput.

Returns the content to be included in the generated output for all instances of block tags handled by this taglet.

pack-priv Content
getExternalSpecContent(Element holder, DocTree docTree, String url, String searchText, Content title)

public InheritableTaglet.Output
inherit(Element dst, Element src, DocTree tag, boolean isFirstSentence)

Implements jdk.javadoc.internal.doclets.formats.html.taglets.InheritableTaglet.inherit.

public Content

Returns:

the output
specTagOutput(Element
the element that owns the doc comment
holder, List<? extends SpecTree>
the array of @spec tags.
specTags)

Returns the output for one or more @spec tags.

private Content
specTagToContent(Element holder, SpecTree specTree)

Inherited from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet:
getAllowedLocationsgetInlineTagOutputgetNamegetTagKindisInlineTag

Field Detail

contentsback to summary
private final Contents contents

Constructor Detail

SpecTagletback to summary
pack-priv SpecTaglet(HtmlConfiguration config)

Method Detail

extractback to summary
private static Optional<SpecTaglet.Documentation> extract(Utils utils, ExecutableElement method)
getAllBlockTagOutputback to summary
public Content getAllBlockTagOutput(Element holder, TagletWriter tagletWriter)

Overrides jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getAllBlockTagOutput.

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getAllBlockTagOutput.

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getAllBlockTagOutput.

Returns the content to be included in the generated output for all instances of block tags handled by this taglet.

Annotations
@Override
getExternalSpecContentback to summary
pack-priv Content getExternalSpecContent(Element holder, DocTree docTree, String url, String searchText, Content title)
inheritback to summary
public InheritableTaglet.Output inherit(Element dst, Element src, DocTree tag, boolean isFirstSentence)

Implements jdk.javadoc.internal.doclets.formats.html.taglets.InheritableTaglet.inherit.

Annotations
@Override
specTagOutputback to summary
public Content specTagOutput(Element holder, List<? extends SpecTree> specTags)

Returns the output for one or more @spec tags.

Parameters
holder:Element

the element that owns the doc comment

specTags:List<? extends SpecTree>

the array of @spec tags.

Returns:Content

the output

specTagToContentback to summary
private Content specTagToContent(Element holder, SpecTree specTree)
jdk.javadoc.internal.doclets.formats.html.taglets back to summary

private final Record SpecTaglet.Documentation

extends Record
Class Inheritance
Record Components
specTrees:List<? extends SpecTree> 
method:ExecutableElement 

Field Summary

Modifier and TypeField and Description
private final ExecutableElement
method

Record Component accessed by method().

private final List<? extends SpecTree>
specTrees

Record Component accessed by specTrees().

Constructor Summary

AccessConstructor and Description
private
Documentation(List<? extends SpecTree> specTrees, ExecutableElement method)

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 ExecutableElement
method()

Record Component getter of method.

public List<? extends SpecTree>
specTrees()

Record Component getter of specTrees.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

methodback to summary
private final ExecutableElement method

Record Component accessed by method().

specTreesback to summary
private final List<? extends SpecTree> specTrees

Record Component accessed by specTrees().

Constructor Detail

Documentationback to summary
private Documentation(List<? extends SpecTree> specTrees, ExecutableElement method)

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.

methodback to summary
public ExecutableElement method()

Record Component getter of method.

specTreesback to summary
public List<? extends SpecTree> specTrees()

Record Component getter of specTrees.

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.