Modifier and Type	Class and Description
public static class	TagletWriter.Context A class that provides the information about the enclosing context for a series of `DocTree` nodes.

Modifier and Type	Field and Description
public final HtmlConfiguration	configuration
public final TagletWriter.Context	context The context in which to generate the output for a series of `DocTree` nodes.
public final HtmlDocletWriter	htmlWriter
public final HtmlOptions	options
public final Resources	resources
private static final int	TAG_LIST_ITEM_MAX_INLINE_LENGTH
public final Utils	utils

Constructor Summary

Access	Constructor and Description
public	TagletWriter(HtmlDocletWriter the `HtmlDocletWriter` for the page htmlWriter, boolean `true` if this taglet writer is being used for a "first sentence" summary isFirstSentence) Creates a taglet writer.
public	TagletWriter(HtmlDocletWriter the `HtmlDocletWriter` for the page htmlWriter, boolean `true` if this taglet writer is being used for a "first sentence" summary, and `false` otherwise isFirstSentence, boolean `true` if this taglet writer is being used for the content of a `{@summary ...}` tag, and `false` otherwise inSummary) Creates a taglet writer.
public	TagletWriter(HtmlDocletWriter the `HtmlDocletWriter` for the page htmlWriter, TagletWriter.Context the enclosing context for any tags context) Creates a taglet writer.

Method Summary

Modifier and Type	Method and Description
public Content	Returns: the generated content commentTagsToOutput(DocTree the tree that holds the documentation holderTree, List<? extends DocTree> list of `DocTree` nodes containing text and inline tags (often alternating) present in the text of interest for this doc trees) Converts inline tags and text to content, expanding the inline tags along the way.
public Content	Returns: the generated content commentTagsToOutput(Element The element that owns the documentation element, List<? extends DocTree> list of `DocTree` nodes containing text and inline tags (often alternating) present in the text of interest for this doc trees) Converts inline tags and text to content, expanding the inline tags along the way.
public Content	Returns: the generated content commentTagsToOutput(Element the element where comment resides element, DocTree the tag that holds the documentation holder, List<? extends DocTree> array of text tags and inline tags (often alternating) present in the text of interest for this doc trees, boolean true if this is the first sentence isFirstSentence) Converts inline tags and text to content, expanding the inline tags along the way.
public Content	createAnchorAndSearchIndex(Element element, String tagText, String desc, DocTree tree)
pack-priv Content	createAnchorAndSearchIndex(Element element, String tagText, Content tagContent, String desc, DocTree tree)
public Content	Returns: the content getBlockTagOutput(TagletManager the manager that manages the taglets tagletManager, Element the element that we are to write tags for element, List<Taglet> the taglets for the tags to write taglets) Returns the content generated from the block tags for a given element.
public TagletWriter.Context	getContext()
public TypeElement	Returns: the type element documented by the current `HtmlDocletWriter` (may be null) getCurrentTypeElement() Returns the type element documented by the current `HtmlDocletWriter` (may be null).
public String	getHolderName(Element element)
private String	getHolderName(DocletElement de)
public Content	Returns: the content, or `null` getInlineTagOutput(Element the element associated with the doc comment holder, InlineTagTree the inline tag to be documented inlineTag) Returns the content generated from an inline tag in the doc comment for a given element, or `null` if the tag is not supported or does not return any output.
public Content	Returns: an instance of an output object getOutputInstance() Returns an instance of an output object.
public Content	Returns: the output invalidTagOutput(String the single-line summary message summary, Optional<String> the optional detail message which may contain preformatted text detail) Returns the output for an invalid tag.
private boolean	isDifferentTypeElement(Element element)
private boolean	isLongOrHasComma(Content c)
pack-priv Content	tagList(List<Content> items)

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

Field Detail

configuration	back to summary
public final HtmlConfiguration configuration

context	back to summary
public final TagletWriter.Context context The context in which to generate the output for a series of `DocTree` nodes.

htmlWriter	back to summary
public final HtmlDocletWriter htmlWriter

options	back to summary
public final HtmlOptions options

resources	back to summary
public final Resources resources

TAG_LIST_ITEM_MAX_INLINE_LENGTH	back to summary
private static final int TAG_LIST_ITEM_MAX_INLINE_LENGTH

utils	back to summary
public final Utils utils

Constructor Detail

TagletWriter back to summary

TagletWriter	back to summary
public TagletWriter(HtmlDocletWriter htmlWriter, boolean isFirstSentence) Creates a taglet writer. Parameters htmlWriter:HtmlDocletWriter the `HtmlDocletWriter` for the page isFirstSentence:boolean `true` if this taglet writer is being used for a "first sentence" summary

public TagletWriter(HtmlDocletWriter htmlWriter, boolean isFirstSentence)

Creates a taglet writer.

Parameters

htmlWriter:HtmlDocletWriter: the HtmlDocletWriter for the page
isFirstSentence:boolean: true if this taglet writer is being used for a "first sentence" summary

TagletWriter back to summary

TagletWriter	back to summary
public TagletWriter(HtmlDocletWriter htmlWriter, boolean isFirstSentence, boolean inSummary) Creates a taglet writer. Parameters htmlWriter:HtmlDocletWriter the `HtmlDocletWriter` for the page isFirstSentence:boolean `true` if this taglet writer is being used for a "first sentence" summary, and `false` otherwise inSummary:boolean `true` if this taglet writer is being used for the content of a `{@summary ...}` tag, and `false` otherwise

public TagletWriter(HtmlDocletWriter htmlWriter, boolean isFirstSentence, boolean inSummary)

Creates a taglet writer.

Parameters

htmlWriter:HtmlDocletWriter: the HtmlDocletWriter for the page
isFirstSentence:boolean: true if this taglet writer is being used for a "first sentence" summary, and false otherwise
inSummary:boolean: true if this taglet writer is being used for the content of a {@summary ...} tag, and false otherwise

TagletWriter back to summary

TagletWriter	back to summary
public TagletWriter(HtmlDocletWriter htmlWriter, TagletWriter.Context context) Creates a taglet writer. Parameters htmlWriter:HtmlDocletWriter the `HtmlDocletWriter` for the page context:TagletWriter.Context the enclosing context for any tags

public TagletWriter(HtmlDocletWriter htmlWriter, TagletWriter.Context context)

Creates a taglet writer.

Parameters

htmlWriter:HtmlDocletWriter: the HtmlDocletWriter for the page
context:TagletWriter.Context: the enclosing context for any tags

Method Detail

commentTagsToOutput back to summary

commentTagsToOutput	back to summary
public Content commentTagsToOutput(DocTree holderTree, List<? extends DocTree> trees) Converts inline tags and text to content, expanding the inline tags along the way. Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to block tags. Parameters holderTree:DocTree the tree that holds the documentation trees:List<? extends DocTree> list of `DocTree` nodes containing text and inline tags (often alternating) present in the text of interest for this doc Returns:Content the generated content

public Content commentTagsToOutput(DocTree holderTree, List<? extends DocTree> trees)

Converts inline tags and text to content, expanding the inline tags along the way. Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to block tags.

Parameters

holderTree:DocTree: the tree that holds the documentation
trees:List<? extends DocTree>: list of DocTree nodes containing text and inline tags (often alternating) present in the text of interest for this doc

Returns:Content

the generated content

commentTagsToOutput back to summary

commentTagsToOutput	back to summary
public Content commentTagsToOutput(Element element, List<? extends DocTree> trees) Converts inline tags and text to content, expanding the inline tags along the way. Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to block tags. Parameters element:Element The element that owns the documentation trees:List<? extends DocTree> list of `DocTree` nodes containing text and inline tags (often alternating) present in the text of interest for this doc Returns:Content the generated content

public Content commentTagsToOutput(Element element, List<? extends DocTree> trees)

Converts inline tags and text to content, expanding the inline tags along the way. Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to block tags.

Parameters

element:Element: The element that owns the documentation
trees:List<? extends DocTree>: list of DocTree nodes containing text and inline tags (often alternating) present in the text of interest for this doc

Returns:Content

the generated content

commentTagsToOutput	back to summary
public Content commentTagsToOutput(Element element, DocTree holder, List<? extends DocTree> trees, boolean isFirstSentence) Converts inline tags and text to content, expanding the inline tags along the way. Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to non-inline tags. Parameters element:Element the element where comment resides holder:DocTree the tag that holds the documentation trees:List<? extends DocTree> array of text tags and inline tags (often alternating) present in the text of interest for this doc isFirstSentence:boolean true if this is the first sentence Returns:Content the generated content

commentTagsToOutput

back to summary

public Content commentTagsToOutput(Element element, DocTree holder, List<? extends DocTree> trees, boolean isFirstSentence)

Converts inline tags and text to content, expanding the inline tags along the way. Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to non-inline tags.

Parameters

element:Element: the element where comment resides
holder:DocTree: the tag that holds the documentation
trees:List<? extends DocTree>: array of text tags and inline tags (often alternating) present in the text of interest for this doc
isFirstSentence:boolean: true if this is the first sentence

Returns:Content

the generated content

createAnchorAndSearchIndex	back to summary
public Content createAnchorAndSearchIndex(Element element, String tagText, String desc, DocTree tree)

createAnchorAndSearchIndex	back to summary
pack-priv Content createAnchorAndSearchIndex(Element element, String tagText, Content tagContent, String desc, DocTree tree)

getBlockTagOutput	back to summary
public Content getBlockTagOutput(TagletManager tagletManager, Element element, List<Taglet> taglets) Returns the content generated from the block tags for a given element. The content is generated according to the order of the list of taglets. The result is a possibly-empty list of the output generated by each of the given taglets for all of the tags they individually support. Parameters tagletManager:TagletManager the manager that manages the taglets element:Element the element that we are to write tags for taglets:List<Taglet> the taglets for the tags to write Returns:Content the content

getBlockTagOutput

back to summary

public Content getBlockTagOutput(TagletManager tagletManager, Element element, List<Taglet> taglets)

Returns the content generated from the block tags for a given element. The content is generated according to the order of the list of taglets. The result is a possibly-empty list of the output generated by each of the given taglets for all of the tags they individually support.

Parameters

tagletManager:TagletManager: the manager that manages the taglets
element:Element: the element that we are to write tags for
taglets:List<Taglet>: the taglets for the tags to write

Returns:Content

the content

getContext	back to summary
public TagletWriter.Context getContext()

getCurrentTypeElement back to summary

getCurrentTypeElement	back to summary
public TypeElement getCurrentTypeElement() Returns the type element documented by the current `HtmlDocletWriter` (may be null). Returns:TypeElement the type element documented by the current `HtmlDocletWriter` (may be null)

public TypeElement getCurrentTypeElement()

Returns the type element documented by the current HtmlDocletWriter (may be null).

Returns:TypeElement: the type element documented by the current HtmlDocletWriter (may be null)

getHolderName	back to summary
public String getHolderName(Element element)

getHolderName	back to summary
private String getHolderName(DocletElement de)

getInlineTagOutput back to summary

getInlineTagOutput	back to summary
public Content getInlineTagOutput(Element holder, InlineTagTree inlineTag) Returns the content generated from an inline tag in the doc comment for a given element, or `null` if the tag is not supported or does not return any output. Parameters holder:Element the element associated with the doc comment inlineTag:InlineTagTree the inline tag to be documented Returns:Content the content, or `null`

public Content getInlineTagOutput(Element holder, InlineTagTree inlineTag)

Returns the content generated from an inline tag in the doc comment for a given element, or null if the tag is not supported or does not return any output.

Parameters

holder:Element: the element associated with the doc comment
inlineTag:InlineTagTree: the inline tag to be documented

Returns:Content

the content, or null

getOutputInstance	back to summary
public Content getOutputInstance() Returns an instance of an output object. Returns:Content an instance of an output object

getOutputInstance

back to summary

public Content getOutputInstance()

Returns an instance of an output object.

Returns:Content: an instance of an output object

invalidTagOutput back to summary

invalidTagOutput	back to summary
public Content invalidTagOutput(String summary, Optional<String> detail) Returns the output for an invalid tag. The returned content uses special styling to highlight the problem. Depending on the presence of the `detail` string the method returns a plain text span or an expandable component. Parameters summary:String the single-line summary message detail:Optional<String> the optional detail message which may contain preformatted text Returns:Content the output

public Content invalidTagOutput(String summary, Optional<String> detail)

Returns the output for an invalid tag. The returned content uses special styling to highlight the problem. Depending on the presence of the detail string the method returns a plain text span or an expandable component.

Parameters

summary:String: the single-line summary message
detail:Optional<String>: the optional detail message which may contain preformatted text

Returns:Content

the output

isDifferentTypeElement	back to summary
private boolean isDifferentTypeElement(Element element)

isLongOrHasComma	back to summary
private boolean isLongOrHasComma(Content c)

tagList	back to summary
pack-priv Content tagList(List<Content> items)

jdk.javadoc.internal.doclets.formats.html.taglets back to summary

public Class TagletWriter.Context

Class Inheritance

extends Object

java.lang.Object
jdk.javadoc.internal.doclets.formats.html.taglets.TagletWriter.Context

A class that provides the information about the enclosing context for a series of DocTree nodes. This context may be used to determine the content that should be generated from the tree nodes.

Field Summary

Modifier and Type	Field and Description
public final boolean	inSummary Whether the trees are appearing in the "summary" section of the page for a declaration.
public final Set<DocTree.Kind>	inTags The set of enclosing kinds of tags.
public final boolean	isFirstSentence Whether the trees are appearing in a context of just the first sentence, such as in the summary table of the enclosing element.

Constructor Summary

Access	Constructor and Description
public	Context(boolean `true` if the trees are appearing in a context of just the first sentence and `false` otherwise isFirstSentence, boolean `true` if the trees are appearing in the "summary" section of the page for a declaration and `false` otherwise inSummary) Creates an outermost context, with no enclosing tags.
private	Context(boolean isFirstSentence, boolean inSummary, Set<DocTree.Kind> inTags)

Method Summary

Modifier and Type	Method and Description
public TagletWriter.Context	Returns: the new `Context` within(DocTree the enclosing tree tree) Creates a new `Context` that includes an extra tag kind in the set of enclosing kinds of tags.

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

Field Detail

inSummary	back to summary
public final boolean inSummary Whether the trees are appearing in the "summary" section of the page for a declaration.

inTags	back to summary
public final Set<DocTree.Kind> inTags The set of enclosing kinds of tags.

isFirstSentence	back to summary
public final boolean isFirstSentence Whether the trees are appearing in a context of just the first sentence, such as in the summary table of the enclosing element.

Constructor Detail

Context back to summary

Context	back to summary
public Context(boolean isFirstSentence, boolean inSummary) Creates an outermost context, with no enclosing tags. Parameters isFirstSentence:boolean `true` if the trees are appearing in a context of just the first sentence and `false` otherwise inSummary:boolean `true` if the trees are appearing in the "summary" section of the page for a declaration and `false` otherwise

public Context(boolean isFirstSentence, boolean inSummary)

Creates an outermost context, with no enclosing tags.

Parameters

isFirstSentence:boolean: true if the trees are appearing in a context of just the first sentence and false otherwise
inSummary:boolean: true if the trees are appearing in the "summary" section of the page for a declaration and false otherwise

Context	back to summary
private Context(boolean isFirstSentence, boolean inSummary, Set<DocTree.Kind> inTags)

Method Detail

within back to summary

within	back to summary
public TagletWriter.Context within(DocTree tree) Creates a new `Context` that includes an extra tag kind in the set of enclosing kinds of tags. Parameters tree:DocTree the enclosing tree Returns:TagletWriter.Context the new `Context`

public TagletWriter.Context within(DocTree tree)

Creates a new Context that includes an extra tag kind in the set of enclosing kinds of tags.

Parameters

tree:DocTree: the enclosing tree

Returns:TagletWriter.Context

the new Context

public Class TagletWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class TagletWriter.Context

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail