Package gw.gosudoc.com.sun.tools.javadoc.main

Class ThrowsTagImpl

java.lang.Object

gw.gosudoc.com.sun.tools.javadoc.main.TagImpl

gw.gosudoc.com.sun.tools.javadoc.main.ThrowsTagImpl

All Implemented Interfaces:

Tag, ThrowsTag

@Deprecated
class ThrowsTagImpl
extends TagImpl
implements ThrowsTag

Deprecated.

Represents a @throws or @exception documentation tag. Parses and holds the exception name and exception comment. The exception name my be the name of a type variable. Note: @exception is a backwards compatible synonymy for @throws.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

See Also:

ExecutableMemberDocImpl.throwsTags()

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	exceptionComment	Deprecated.
private java.lang.String	exceptionName	Deprecated.
private Tag[]	inlineTags	Deprecated. Cached inline tags.

Fields inherited from class gw.gosudoc.com.sun.tools.javadoc.main.TagImpl

holder, name, text

Constructor Summary

Constructors

Constructor	Description
ThrowsTagImpl(DocImpl holder, java.lang.String name, java.lang.String text)	Deprecated.

Method Summary

Modifier and Type	Method	Description
ClassDoc	exception()	Deprecated. Return the exception as a ClassDocImpl.
java.lang.String	exceptionComment()	Deprecated. Return the exception comment.
java.lang.String	exceptionName()	Deprecated. Return the exception name.
Type	exceptionType()	Deprecated. Return the type that represents the exception.
Tag[]	inlineTags()	Deprecated. For the exception comment with embedded @link tags return the array of TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).
java.lang.String	kind()	Deprecated. Return the kind of this tag.

Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.TagImpl

divideAtWhite, docenv, firstSentenceTags, holder, name, position, text, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gw.gosudoc.com.sun.javadoc.Tag

firstSentenceTags, holder, name, position, text, toString

Field Detail

exceptionName

private final java.lang.String exceptionName

Deprecated.

exceptionComment

private final java.lang.String exceptionComment

Deprecated.

inlineTags

private Tag[] inlineTags

Deprecated.

Cached inline tags.

Constructor Detail

ThrowsTagImpl

ThrowsTagImpl(DocImpl holder,
              java.lang.String name,
              java.lang.String text)

Deprecated.

Method Detail

exceptionName

public java.lang.String exceptionName()

Deprecated.

Return the exception name.

Specified by:

exceptionName in interface ThrowsTag

Returns:

name of the exception.

exceptionComment

public java.lang.String exceptionComment()

Deprecated.

Return the exception comment.

Specified by:

exceptionComment in interface ThrowsTag

Returns:

exception comment.

exception

public ClassDoc exception()

Deprecated.

Return the exception as a ClassDocImpl.

Specified by:

exception in interface ThrowsTag

Returns:

ClassDoc that represents the exception.

See Also:

ThrowsTag.exceptionType()

exceptionType

public Type exceptionType()

Deprecated.

Return the type that represents the exception. This may be a ClassDoc or a TypeVariable.

Specified by:

exceptionType in interface ThrowsTag

Returns:

the type of the exception.

kind

public java.lang.String kind()

Deprecated.

Return the kind of this tag. Always "@throws" for instances of ThrowsTagImpl.

Specified by:

kind in interface Tag

Overrides:

kind in class TagImpl

Returns:

the kind of this tag.

inlineTags

public Tag[] inlineTags()

Deprecated.

For the exception comment with embedded @link tags return the array of TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).

Specified by:

inlineTags in interface Tag

Overrides:

inlineTags in class TagImpl

Returns:

TagImpl[] Array of tags with inline SeeTagImpls.

See Also:

TagImpl.inlineTags(), ParamTagImpl.inlineTags()