0N/A/*
553N/A * Copyright (c) 1998, 2003, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
553N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
553N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
553N/A * or visit www.oracle.com if you need additional information or have any
553N/A * questions.
0N/A */
0N/A
0N/Apackage com.sun.javadoc;
0N/A
0N/A/**
0N/A * Represents a @throws or @exception documentation tag.
0N/A * Parses and holds the exception name and exception comment.
0N/A * Note: @exception is a backwards compatible synonymy for @throws.
0N/A *
0N/A * @author Robert Field
0N/A * @author Atul M Dambalkar
0N/A * @see ExecutableMemberDoc#throwsTags()
0N/A *
0N/A */
0N/Apublic interface ThrowsTag extends Tag {
0N/A
0N/A /**
0N/A * Return the name of the exception
0N/A * associated with this <code>ThrowsTag</code>.
0N/A *
0N/A * @return name of the exception.
0N/A */
0N/A String exceptionName();
0N/A
0N/A /**
0N/A * Return the exception comment
0N/A * associated with this <code>ThrowsTag</code>.
0N/A *
0N/A * @return exception comment.
0N/A */
0N/A String exceptionComment();
0N/A
0N/A /**
0N/A * Return a <code>ClassDoc</code> that represents the exception.
0N/A * If the type of the exception is a type variable, return the
0N/A * <code>ClassDoc</code> of its erasure.
0N/A *
0N/A * <p> <i>This method cannot accommodate certain generic type
0N/A * constructs. The <code>exceptionType</code> method
0N/A * should be used instead.</i>
0N/A *
0N/A * @return <code>ClassDoc</code> that represents the exception.
0N/A * @see #exceptionType
0N/A */
0N/A ClassDoc exception();
0N/A
0N/A /**
0N/A * Return the type of the exception
0N/A * associated with this <code>ThrowsTag</code>.
0N/A * This may be a <code>ClassDoc</code> or a <code>TypeVariable</code>.
0N/A *
0N/A * @return the type of the exception.
0N/A * @since 1.5
0N/A */
0N/A Type exceptionType();
0N/A}