ThrowsTag.java revision 2571:10fc81ac75b4 
1/*
2 * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
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
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
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 *
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.
24 */
25
26package 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 */
38public interface ThrowsTag extends Tag {
39
40    /**
41     * Return the name of the exception
42     * associated with this {@code ThrowsTag}.
43     *
44     * @return name of the exception.
45     */
46    String exceptionName();
47
48    /**
49     * Return the exception comment
50     * associated with this {@code ThrowsTag}.
51     *
52     * @return exception comment.
53     */
54    String exceptionComment();
55
56    /**
57     * Return a {@code ClassDoc} that represents the exception.
58     * If the type of the exception is a type variable, return the
59     * {@code ClassDoc} of its erasure.
60     *
61     * <p> <i>This method cannot accommodate certain generic type
62     * constructs.  The {@code exceptionType} method
63     * should be used instead.</i>
64     *
65     * @return {@code ClassDoc} 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}.
73     * This may be a {@code ClassDoc} or a {@code TypeVariable}.
74     *
75     * @return the type of the exception.
76     * @since 1.5
77     */
78    Type exceptionType();
79}
80