- All Superinterfaces:
DocTree
,InlineTagTree
A tree node for an
@snippet
inline tag.
{@snippet : body } {@snippet attributes} {@snippet attributes : body }
- Since:
- 18
-
Nested Class Summary
Nested classes/interfaces declared in interface com.sun.source.doctree.DocTree
DocTree.Kind
-
Method Summary
Modifier and TypeMethodDescriptionReturns the list of the attributes of the@snippet
tag.getBody()
Returns the body of the@snippet
tag, ornull
if there is no body.Methods declared in interface com.sun.source.doctree.InlineTagTree
getTagName
-
Method Details
-
getAttributes
Returns the list of the attributes of the@snippet
tag.- Returns:
- the list of the attributes
-
getBody
TextTree getBody()Returns the body of the@snippet
tag, ornull
if there is no body.- API Note:
- An instance of
SnippetTree
with an empty body differs from an instance ofSnippetTree
with no body. If a tag has no body, then calling this method returnsnull
. If a tag has an empty body, then this method returns aTextTree
whoseTextTree.getBody()
returns an empty string. - Returns:
- the body of the tag, or
null
if there is no body
-