Package gw.gosudoc.com.sun.javadoc
Interface ThrowsTag
- All Superinterfaces:
Tag
- All Known Implementing Classes:
ThrowsTagImpl
Deprecated.
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.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Return aClassDoc
that represents the exception.Deprecated.Return the exception comment associated with thisThrowsTag
.Deprecated.Return the name of the exception associated with thisThrowsTag
.Deprecated.Return the type of the exception associated with thisThrowsTag
.Methods inherited from interface gw.gosudoc.com.sun.javadoc.Tag
firstSentenceTags, holder, inlineTags, kind, name, position, text, toString
-
Method Details
-
exceptionName
String exceptionName()Deprecated.Return the name of the exception associated with thisThrowsTag
.- Returns:
- name of the exception.
-
exceptionComment
String exceptionComment()Deprecated.Return the exception comment associated with thisThrowsTag
.- Returns:
- exception comment.
-
exception
ClassDoc exception()Deprecated.Return aClassDoc
that represents the exception. If the type of the exception is a type variable, return theClassDoc
of its erasure.This method cannot accommodate certain generic type constructs. The
exceptionType
method should be used instead.- Returns:
ClassDoc
that represents the exception.- See Also:
-
exceptionType
Type exceptionType()Deprecated.Return the type of the exception associated with thisThrowsTag
. This may be aClassDoc
or aTypeVariable
.- Returns:
- the type of the exception.
- Since:
- 1.5
-
jdk.javadoc.doclet
. For more information, see the Migration Guide in the documentation for that package.