Module jdk.javadoc

Interface ThrowsTag

  • All Superinterfaces:
    Tag

    @Deprecated
    public interface ThrowsTag
    extends Tag
    Deprecated.
    The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.
    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 Detail

      • exceptionName

        String exceptionName()
        Deprecated.
        Return the name of the exception associated with this ThrowsTag.
        Returns:
        name of the exception.
      • exceptionComment

        String exceptionComment()
        Deprecated.
        Return the exception comment associated with this ThrowsTag.
        Returns:
        exception comment.
      • exception

        ClassDoc exception()
        Deprecated.
        Return a 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.

        Returns:
        ClassDoc that represents the exception.
        See Also:
        exceptionType()
      • exceptionType

        Type exceptionType()
        Deprecated.
        Return the type of the exception associated with this ThrowsTag. This may be a ClassDoc or a TypeVariable.
        Returns:
        the type of the exception.
        Since:
        1.5