• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/javadoc/ThrowsTag.java@959103a6100f (annotated)

src/share/classes/com/sun/javadoc/ThrowsTag.java

Wed, 27 Apr 2016 01:34:52 +0800

author

aoqi

date

Wed, 27 Apr 2016 01:34:52 +0800

changeset 0

959103a6100f

child 2525

2eb010b6cb22

permissions

-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1998, 2003, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.javadoc;
aoqi@0	27
aoqi@0	28	/**
aoqi@0	29	* Represents a @throws or @exception documentation tag.
aoqi@0	30	* Parses and holds the exception name and exception comment.
aoqi@0	31	* Note: @exception is a backwards compatible synonymy for @throws.
aoqi@0	32	*
aoqi@0	33	* @author Robert Field
aoqi@0	34	* @author Atul M Dambalkar
aoqi@0	35	* @see ExecutableMemberDoc#throwsTags()
aoqi@0	36	*
aoqi@0	37	*/
aoqi@0	38	public interface ThrowsTag extends Tag {
aoqi@0	39
aoqi@0	40	/**
aoqi@0	41	* Return the name of the exception
aoqi@0	42	* associated with this <code>ThrowsTag</code>.
aoqi@0	43	*
aoqi@0	44	* @return name of the exception.
aoqi@0	45	*/
aoqi@0	46	String exceptionName();
aoqi@0	47
aoqi@0	48	/**
aoqi@0	49	* Return the exception comment
aoqi@0	50	* associated with this <code>ThrowsTag</code>.
aoqi@0	51	*
aoqi@0	52	* @return exception comment.
aoqi@0	53	*/
aoqi@0	54	String exceptionComment();
aoqi@0	55
aoqi@0	56	/**
aoqi@0	57	* Return a <code>ClassDoc</code> that represents the exception.
aoqi@0	58	* If the type of the exception is a type variable, return the
aoqi@0	59	* <code>ClassDoc</code> of its erasure.
aoqi@0	60	*
aoqi@0	61	* <p> <i>This method cannot accommodate certain generic type
aoqi@0	62	* constructs. The <code>exceptionType</code> method
aoqi@0	63	* should be used instead.</i>
aoqi@0	64	*
aoqi@0	65	* @return <code>ClassDoc</code> that represents the exception.
aoqi@0	66	* @see #exceptionType
aoqi@0	67	*/
aoqi@0	68	ClassDoc exception();
aoqi@0	69
aoqi@0	70	/**
aoqi@0	71	* Return the type of the exception
aoqi@0	72	* associated with this <code>ThrowsTag</code>.
aoqi@0	73	* This may be a <code>ClassDoc</code> or a <code>TypeVariable</code>.
aoqi@0	74	*
aoqi@0	75	* @return the type of the exception.
aoqi@0	76	* @since 1.5
aoqi@0	77	*/
aoqi@0	78	Type exceptionType();
aoqi@0	79	}