Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/ThrowsTagImpl.java@4868a36f6fd8 (annotated)
src/share/classes/com/sun/tools/javadoc/ThrowsTagImpl.java
Tue, 28 Dec 2010 15:54:52 -0800
- author
- ohair
- date
- Tue, 28 Dec 2010 15:54:52 -0800
- changeset 798
- 4868a36f6fd8
- parent 554
- 9d9f26857129
- child 1053
- 0d8edba73d70
- permissions
- -rw-r--r--
6962318: Update copyright year
Reviewed-by: xdono
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 1997, 2003, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.javadoc; |
| duke@1 | 27 | |
| duke@1 | 28 | import com.sun.javadoc.*; |
| duke@1 | 29 | |
| duke@1 | 30 | /** |
| duke@1 | 31 | * Represents a @throws or @exception documentation tag. |
| duke@1 | 32 | * Parses and holds the exception name and exception comment. |
| duke@1 | 33 | * The exception name my be the name of a type variable. |
| duke@1 | 34 | * Note: @exception is a backwards compatible synonymy for @throws. |
| duke@1 | 35 | * |
| duke@1 | 36 | * @author Robert Field |
| duke@1 | 37 | * @author Atul M Dambalkar |
| duke@1 | 38 | * @see ExecutableMemberDocImpl#throwsTags() |
| duke@1 | 39 | * |
| duke@1 | 40 | */ |
| duke@1 | 41 | class ThrowsTagImpl extends TagImpl implements ThrowsTag { |
| duke@1 | 42 | |
| duke@1 | 43 | private final String exceptionName; |
| duke@1 | 44 | private final String exceptionComment; |
| duke@1 | 45 | |
| duke@1 | 46 | ThrowsTagImpl(DocImpl holder, String name, String text) { |
| duke@1 | 47 | super(holder, name, text); |
| duke@1 | 48 | String[] sa = divideAtWhite(); |
| duke@1 | 49 | exceptionName = sa[0]; |
| duke@1 | 50 | exceptionComment = sa[1]; |
| duke@1 | 51 | } |
| duke@1 | 52 | |
| duke@1 | 53 | /** |
| duke@1 | 54 | * Return the exception name. |
| duke@1 | 55 | */ |
| duke@1 | 56 | public String exceptionName() { |
| duke@1 | 57 | return exceptionName; |
| duke@1 | 58 | } |
| duke@1 | 59 | |
| duke@1 | 60 | /** |
| duke@1 | 61 | * Return the exception comment. |
| duke@1 | 62 | */ |
| duke@1 | 63 | public String exceptionComment() { |
| duke@1 | 64 | return exceptionComment; |
| duke@1 | 65 | } |
| duke@1 | 66 | |
| duke@1 | 67 | /** |
| duke@1 | 68 | * Return the exception as a ClassDocImpl. |
| duke@1 | 69 | */ |
| duke@1 | 70 | public ClassDoc exception() { |
| duke@1 | 71 | ClassDocImpl exceptionClass; |
| duke@1 | 72 | if (!(holder instanceof ExecutableMemberDoc)) { |
| duke@1 | 73 | exceptionClass = null; |
| duke@1 | 74 | } else { |
| duke@1 | 75 | ExecutableMemberDocImpl emd = (ExecutableMemberDocImpl)holder; |
| duke@1 | 76 | ClassDocImpl con = (ClassDocImpl)emd.containingClass(); |
| duke@1 | 77 | exceptionClass = (ClassDocImpl)con.findClass(exceptionName); |
| duke@1 | 78 | } |
| duke@1 | 79 | return exceptionClass; |
| duke@1 | 80 | } |
| duke@1 | 81 | |
| duke@1 | 82 | /** |
| duke@1 | 83 | * Return the type that represents the exception. |
| duke@1 | 84 | * This may be a <code>ClassDoc</code> or a <code>TypeVariable</code>. |
| duke@1 | 85 | */ |
| duke@1 | 86 | public Type exceptionType() { |
| duke@1 | 87 | //###(gj) TypeVariable not yet supported. |
| duke@1 | 88 | return exception(); |
| duke@1 | 89 | } |
| duke@1 | 90 | |
| duke@1 | 91 | |
| duke@1 | 92 | /** |
| duke@1 | 93 | * Return the kind of this tag. Always "@throws" for instances |
| duke@1 | 94 | * of ThrowsTagImpl. |
| duke@1 | 95 | */ |
| duke@1 | 96 | public String kind() { |
| duke@1 | 97 | return "@throws"; |
| duke@1 | 98 | } |
| duke@1 | 99 | |
| duke@1 | 100 | /** |
| duke@1 | 101 | * For the exception comment with embedded @link tags return the array of |
| duke@1 | 102 | * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s). |
| duke@1 | 103 | * |
| duke@1 | 104 | * @return TagImpl[] Array of tags with inline SeeTagImpls. |
| duke@1 | 105 | * @see TagImpl#inlineTagImpls() |
| duke@1 | 106 | * @see ParamTagImpl#inlineTagImpls() |
| duke@1 | 107 | */ |
| duke@1 | 108 | public Tag[] inlineTags() { |
| duke@1 | 109 | return Comment.getInlineTags(holder, exceptionComment()); |
| duke@1 | 110 | } |
| duke@1 | 111 | } |
