Module jdk.compiler

Package com.sun.source.doctree

Interface ThrowsTree

All Superinterfaces:

BlockTagTree, DocTree

public interface ThrowsTree
extends BlockTagTree

A tree node for an @exception or @throws block tag. @exception is a synonym for @throws.

@exception class-name description
@throws class-name description

Since:

1.8

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.source.doctree.DocTree

DocTree.Kind

Method Summary

Modifier and Type	Method and Description
List<? extends DocTree>	getDescription() Returns the description of the reasons why the exception may be thrown.
ReferenceTree	getExceptionName() Returns a name of the exception being documented.

Methods inherited from interface com.sun.source.doctree.BlockTagTree

getTagName

Methods inherited from interface com.sun.source.doctree.DocTree

accept, getKind

Method Detail

getExceptionName

ReferenceTree getExceptionName()

Returns a name of the exception being documented.

Returns:

the name of the exception

getDescription

List<? extends DocTree> getDescription()

Returns the description of the reasons why the exception may be thrown.

Returns:

the description