1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/javadoc/ThrowsTagImpl.java Sat Dec 01 00:00:00 2007 +0000
1.3 @@ -0,0 +1,111 @@
1.4 +/*
1.5 + * Copyright 1997-2003 Sun Microsystems, Inc. All Rights Reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Sun designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Sun in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or
1.26 + * have any questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.javadoc;
1.30 +
1.31 +import com.sun.javadoc.*;
1.32 +
1.33 +/**
1.34 + * Represents a @throws or @exception documentation tag.
1.35 + * Parses and holds the exception name and exception comment.
1.36 + * The exception name my be the name of a type variable.
1.37 + * Note: @exception is a backwards compatible synonymy for @throws.
1.38 + *
1.39 + * @author Robert Field
1.40 + * @author Atul M Dambalkar
1.41 + * @see ExecutableMemberDocImpl#throwsTags()
1.42 + *
1.43 + */
1.44 +class ThrowsTagImpl extends TagImpl implements ThrowsTag {
1.45 +
1.46 + private final String exceptionName;
1.47 + private final String exceptionComment;
1.48 +
1.49 + ThrowsTagImpl(DocImpl holder, String name, String text) {
1.50 + super(holder, name, text);
1.51 + String[] sa = divideAtWhite();
1.52 + exceptionName = sa[0];
1.53 + exceptionComment = sa[1];
1.54 + }
1.55 +
1.56 + /**
1.57 + * Return the exception name.
1.58 + */
1.59 + public String exceptionName() {
1.60 + return exceptionName;
1.61 + }
1.62 +
1.63 + /**
1.64 + * Return the exception comment.
1.65 + */
1.66 + public String exceptionComment() {
1.67 + return exceptionComment;
1.68 + }
1.69 +
1.70 + /**
1.71 + * Return the exception as a ClassDocImpl.
1.72 + */
1.73 + public ClassDoc exception() {
1.74 + ClassDocImpl exceptionClass;
1.75 + if (!(holder instanceof ExecutableMemberDoc)) {
1.76 + exceptionClass = null;
1.77 + } else {
1.78 + ExecutableMemberDocImpl emd = (ExecutableMemberDocImpl)holder;
1.79 + ClassDocImpl con = (ClassDocImpl)emd.containingClass();
1.80 + exceptionClass = (ClassDocImpl)con.findClass(exceptionName);
1.81 + }
1.82 + return exceptionClass;
1.83 + }
1.84 +
1.85 + /**
1.86 + * Return the type that represents the exception.
1.87 + * This may be a <code>ClassDoc</code> or a <code>TypeVariable</code>.
1.88 + */
1.89 + public Type exceptionType() {
1.90 + //###(gj) TypeVariable not yet supported.
1.91 + return exception();
1.92 + }
1.93 +
1.94 +
1.95 + /**
1.96 + * Return the kind of this tag. Always "@throws" for instances
1.97 + * of ThrowsTagImpl.
1.98 + */
1.99 + public String kind() {
1.100 + return "@throws";
1.101 + }
1.102 +
1.103 + /**
1.104 + * For the exception comment with embedded @link tags return the array of
1.105 + * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).
1.106 + *
1.107 + * @return TagImpl[] Array of tags with inline SeeTagImpls.
1.108 + * @see TagImpl#inlineTagImpls()
1.109 + * @see ParamTagImpl#inlineTagImpls()
1.110 + */
1.111 + public Tag[] inlineTags() {
1.112 + return Comment.getInlineTags(holder, exceptionComment());
1.113 + }
1.114 +}
