ThrowsTree.java revision 2571:10fc81ac75b4 
1/*
2 * Copyright (c) 2011, 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.source.doctree;
27
28import java.util.List;
29
30/**
31 *
32 * A tree node for an @exception or @throws block tag.
33 * @exception is a synonym for @throws.
34 *
35 * <p>
36 * &#064;exception class-name description <br>
37 * &#064;throws class-name description
38 *
39 * @since 1.8
40 */
41@jdk.Exported
42public interface ThrowsTree extends BlockTagTree {
43    /**
44     * Returns a name of the exception being documented.
45     * @return the name of the exception
46     */
47    ReferenceTree getExceptionName();
48
49    /**
50     * Returns the description of the reasons why the
51     * exception may be thrown.
52     * @return the description
53     */
54    List<? extends DocTree> getDescription();
55}
56