APIdia Launch Partner
Top Description Methods
com.sun.source.doctree

public Interface SnippetTree

extends InlineTagTree
Known Direct Implementers
com.sun.tools.javac.tree.DCTree.DCSnippet
Imports
java.util.List
A tree node for an @snippet inline tag. 
   {@snippet :
    body
   }

   {@snippet attributes}

   {@snippet attributes :
    body
   }
Since
18

Method Summary

Modifier and TypeMethod and Description
public List<? extends DocTree>

Returns:

the list of the attributes
getAttributes()

Returns the list of the attributes of the @snippet tag.

public TextTree

Returns:

the body of the tag, or null if there is no body
getBody()

Returns the body of the @snippet tag, or null if there is no body.

Inherited from com.sun.source.doctree.InlineTagTree:
getTagName

Method Detail

getAttributesback to summary
public List<? extends DocTree> getAttributes()

Returns the list of the attributes of the @snippet tag.

Returns:List<? extends DocTree>

the list of the attributes

getBodyback to summary
public TextTree getBody()

Returns the body of the @snippet tag, or null if there is no body.

API Note

An instance of SnippetTree with an empty body differs from an instance of SnippetTree with no body. If a tag has no body, then calling this method returns null. If a tag has an empty body, then this method returns a TextTree whose TextTree#getBody() returns an empty string.

Returns:TextTree

the body of the tag, or null if there is no body