|
Doclet API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ThrowsTag
Represents a @throws or @exception documentation tag. Parses and holds the exception name and exception comment. Note: @exception is a backwards compatible synonymy for @throws.
ExecutableMemberDoc.throwsTags()
Method Summary | |
---|---|
ClassDoc |
exception()
Return a ClassDoc that represents the exception. |
String |
exceptionComment()
Return the exception comment associated with this ThrowsTag . |
String |
exceptionName()
Return the name of the exception associated with this ThrowsTag . |
Type |
exceptionType()
Return the type of the exception associated with this ThrowsTag . |
Methods inherited from interface com.sun.javadoc.Tag |
---|
firstSentenceTags, holder, inlineTags, kind, name, position, text, toString |
Method Detail |
---|
String exceptionName()
ThrowsTag
.
String exceptionComment()
ThrowsTag
.
ClassDoc exception()
ClassDoc
that represents the exception.
If the type of the exception is a type variable, return the
ClassDoc
of its erasure.
This method cannot accommodate certain generic type
constructs. The exceptionType
method
should be used instead.
ClassDoc
that represents the exception.exceptionType()
Type exceptionType()
ThrowsTag
.
This may be a ClassDoc
or a TypeVariable
.
|
Doclet API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |