- 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@snippettag.getBody()Returns the body of the@snippettag, ornullif 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@snippettag.- Returns:
- the list of the attributes
-
getBody
TextTree getBody()Returns the body of the@snippettag, ornullif there is no body.- API Note:
- An instance of
SnippetTreewith an empty body differs from an instance ofSnippetTreewith no body. If a tag has no body, then calling this method returnsnull. If a tag has an empty body, then this method returns aTextTreewhoseTextTree.getBody()returns an empty string. - Returns:
- the body of the tag, or
nullif there is no body
-