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