KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > javadoc > ThrowsTag


1 /*
2  * @(#)ThrowsTag.java 1.9 03/12/19
3  *
4  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */
7
8 package com.sun.javadoc;
9
10 /**
11  * Represents a @throws or @exception documentation tag.
12  * Parses and holds the exception name and exception comment.
13  * Note: @exception is a backwards compatible synonymy for @throws.
14  *
15  * @author Robert Field
16  * @author Atul M Dambalkar
17  * @see ExecutableMemberDoc#throwsTags()
18  *
19  */
20 public interface ThrowsTag extends Tag {
21
22     /**
23      * Return the name of the exception
24      * associated with this <code>ThrowsTag</code>.
25      *
26      * @return name of the exception.
27      */
28     String JavaDoc exceptionName();
29
30     /**
31      * Return the exception comment
32      * associated with this <code>ThrowsTag</code>.
33      *
34      * @return exception comment.
35      */
36     String JavaDoc exceptionComment();
37
38     /**
39      * Return a <code>ClassDoc</code> that represents the exception.
40      * If the type of the exception is a type variable, return the
41      * <code>ClassDoc</code> of its erasure.
42      *
43      * <p> <i>This method cannot accommodate certain generic type
44      * constructs. The <code>exceptionType</code> method
45      * should be used instead.</i>
46      *
47      * @return <code>ClassDoc</code> that represents the exception.
48      * @see #exceptionType
49      */
50     ClassDoc exception();
51
52     /**
53      * Return the type of the exception
54      * associated with this <code>ThrowsTag</code>.
55      * This may be a <code>ClassDoc</code> or a <code>TypeVariable</code>.
56      *
57      * @return the type of the exception.
58      * @since 1.5
59      */
60     Type exceptionType();
61 }
62
Popular Tags