ThrowsTag (Doclet API)

Package | Class | Use | Tree | Deprecated | Index | Help

Doclet API

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sun.javadoc
Interface ThrowsTag

All Superinterfaces:
  Tag

public interface ThrowsTag
extends Tag

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:
  `ExecutableMemberDoc.throwsTags()`

Method Summary
`ClassDoc` | `exception()` Return a `ClassDoc` which 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`.

Methods inherited from interface com.sun.javadoc.Tag
`firstSentenceTags, inlineTags, kind, name, position, text, toString`

Method Detail

### exceptionName

    public String exceptionName()

  Return the name of the exception associated with this `ThrowsTag`.

  Returns:
    name of the exception.

### exceptionComment

    public String exceptionComment()

  Return the exception comment associated with this `ThrowsTag`.

  Returns:
    exception comment.

### exception

    public ClassDoc exception()

  Return a `ClassDoc` which represents the exception.

  Returns:
    `ClassDoc` which represents the exception.

Package | Class | Use | Tree | Deprecated | Index | Help

Doclet API

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.