ThrowsTree.java revision 3831:209b0eab0e1f
1238901Sandrew/* 2238901Sandrew * Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved. 3238901Sandrew * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4238901Sandrew * 5238901Sandrew * This code is free software; you can redistribute it and/or modify it 6238901Sandrew * under the terms of the GNU General Public License version 2 only, as 7238901Sandrew * published by the Free Software Foundation. Oracle designates this 8238901Sandrew * particular file as subject to the "Classpath" exception as provided 9238901Sandrew * by Oracle in the LICENSE file that accompanied this code. 10238901Sandrew * 11238901Sandrew * This code is distributed in the hope that it will be useful, but WITHOUT 12238901Sandrew * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13238901Sandrew * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14238901Sandrew * version 2 for more details (a copy is included in the LICENSE file that 15238901Sandrew * accompanied this code). 16238901Sandrew * 17238901Sandrew * You should have received a copy of the GNU General Public License version 18238901Sandrew * 2 along with this work; if not, write to the Free Software Foundation, 19238901Sandrew * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20238901Sandrew * 21238901Sandrew * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22238901Sandrew * or visit www.oracle.com if you need additional information or have any 23238901Sandrew * questions. 24238901Sandrew */ 25238901Sandrew 26238901Sandrewpackage com.sun.source.doctree; 27238901Sandrew 28238901Sandrewimport java.util.List; 29238901Sandrew 30238901Sandrew/** 31238901Sandrew * 32238901Sandrew * A tree node for an @exception or @throws block tag. 33238901Sandrew * @exception is a synonym for @throws. 34238901Sandrew * 35238901Sandrew * <p> 36238901Sandrew * @exception class-name description <br> 37238901Sandrew * @throws class-name description 38238901Sandrew * 39238901Sandrew * @since 1.8 40238901Sandrew */ 41238901Sandrewpublic interface ThrowsTree extends BlockTagTree { 42238901Sandrew /** 43238901Sandrew * Returns the name of the exception being documented. 44238901Sandrew * @return the name of the exception 45238901Sandrew */ 46238901Sandrew ReferenceTree getExceptionName(); 47238901Sandrew 48238901Sandrew /** 49238901Sandrew * Returns a description of the reasons why the 50238901Sandrew * exception may be thrown. 51238901Sandrew * @return the description 52238901Sandrew */ 53238901Sandrew List<? extends DocTree> getDescription(); 54238901Sandrew} 55238901Sandrew