src/share/classes/com/sun/tools/javadoc/ThrowsTagImpl.java

Mon, 25 Mar 2013 16:55:14 -0700

author
mfang
date
Mon, 25 Mar 2013 16:55:14 -0700
changeset 1658
fdf30b225e1c
parent 1359
25e14ad23cef
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8010521: jdk8 l10n resource file translation update 2
Reviewed-by: naoto, yhuang

duke@1 1 /*
jjg@1358 2 * Copyright (c) 1997, 2012, 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 *
jjg@1359 36 * <p><b>This is NOT part of any supported API.
jjg@1359 37 * If you write code that depends on this, you do so at your own risk.
jjg@1359 38 * This code and its internal interfaces are subject to change or
jjg@1359 39 * deletion without notice.</b>
jjg@1359 40 *
duke@1 41 * @author Robert Field
duke@1 42 * @author Atul M Dambalkar
duke@1 43 * @see ExecutableMemberDocImpl#throwsTags()
duke@1 44 *
duke@1 45 */
duke@1 46 class ThrowsTagImpl extends TagImpl implements ThrowsTag {
duke@1 47
duke@1 48 private final String exceptionName;
duke@1 49 private final String exceptionComment;
duke@1 50
ksrini@1053 51 /**
ksrini@1053 52 * Cached inline tags.
ksrini@1053 53 */
ksrini@1053 54 private Tag[] inlineTags;
ksrini@1053 55
duke@1 56 ThrowsTagImpl(DocImpl holder, String name, String text) {
duke@1 57 super(holder, name, text);
duke@1 58 String[] sa = divideAtWhite();
duke@1 59 exceptionName = sa[0];
duke@1 60 exceptionComment = sa[1];
duke@1 61 }
duke@1 62
duke@1 63 /**
duke@1 64 * Return the exception name.
duke@1 65 */
duke@1 66 public String exceptionName() {
duke@1 67 return exceptionName;
duke@1 68 }
duke@1 69
duke@1 70 /**
duke@1 71 * Return the exception comment.
duke@1 72 */
duke@1 73 public String exceptionComment() {
duke@1 74 return exceptionComment;
duke@1 75 }
duke@1 76
duke@1 77 /**
duke@1 78 * Return the exception as a ClassDocImpl.
duke@1 79 */
duke@1 80 public ClassDoc exception() {
duke@1 81 ClassDocImpl exceptionClass;
duke@1 82 if (!(holder instanceof ExecutableMemberDoc)) {
duke@1 83 exceptionClass = null;
duke@1 84 } else {
duke@1 85 ExecutableMemberDocImpl emd = (ExecutableMemberDocImpl)holder;
duke@1 86 ClassDocImpl con = (ClassDocImpl)emd.containingClass();
duke@1 87 exceptionClass = (ClassDocImpl)con.findClass(exceptionName);
duke@1 88 }
duke@1 89 return exceptionClass;
duke@1 90 }
duke@1 91
duke@1 92 /**
duke@1 93 * Return the type that represents the exception.
duke@1 94 * This may be a <code>ClassDoc</code> or a <code>TypeVariable</code>.
duke@1 95 */
duke@1 96 public Type exceptionType() {
duke@1 97 //###(gj) TypeVariable not yet supported.
duke@1 98 return exception();
duke@1 99 }
duke@1 100
duke@1 101
duke@1 102 /**
duke@1 103 * Return the kind of this tag. Always "@throws" for instances
duke@1 104 * of ThrowsTagImpl.
duke@1 105 */
ksrini@1053 106 @Override
duke@1 107 public String kind() {
duke@1 108 return "@throws";
duke@1 109 }
duke@1 110
duke@1 111 /**
duke@1 112 * For the exception comment with embedded @link tags return the array of
duke@1 113 * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).
duke@1 114 *
duke@1 115 * @return TagImpl[] Array of tags with inline SeeTagImpls.
jjg@1358 116 * @see TagImpl#inlineTags()
jjg@1358 117 * @see ParamTagImpl#inlineTags()
duke@1 118 */
ksrini@1053 119 @Override
duke@1 120 public Tag[] inlineTags() {
ksrini@1053 121 if (inlineTags == null) {
ksrini@1053 122 inlineTags = Comment.getInlineTags(holder, exceptionComment());
ksrini@1053 123 }
ksrini@1053 124 return inlineTags;
duke@1 125 }
duke@1 126 }

mercurial