Interface DeprecatedTree

All Superinterfaces:

BlockTagTree, DocTree

public interface DeprecatedTree
extends BlockTagTree

A tree node for an @deprecated block tag.

   @deprecated deprecated text

Since:

1.8

Nested Class Summary

Nested classes/interfaces declared in interface DocTree

DocTree.Kind

Modifier and Type	Interface	Description
static enum	DocTree.Kind	Enumerates all kinds of trees.

Method Summary

Modifier and Type	Method	Description
List<? extends DocTree>	getBody()	Returns the description explaining why an item is deprecated.

Methods declared in interface BlockTagTree

getTagName

Modifier and Type	Method	Description
String	getTagName()	Returns the name of the tag.

Methods declared in interface DocTree

accept, getKind

Modifier and Type	Method	Description
<R,D> R	accept(DocTreeVisitor<R,D> visitor, D data)	Accept method used to implement the visitor pattern.
DocTree.Kind	getKind()	Returns the kind of this tree.

Method Details

getBody

List<? extends DocTree> getBody()

Returns the description explaining why an item is deprecated.

Returns:

the description