duke@1: /*
duke@1: * Copyright 1997-2003 Sun Microsystems, Inc. All Rights Reserved.
duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1: *
duke@1: * This code is free software; you can redistribute it and/or modify it
duke@1: * under the terms of the GNU General Public License version 2 only, as
duke@1: * published by the Free Software Foundation. Sun designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
duke@1: * by Sun in the LICENSE file that accompanied this code.
duke@1: *
duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1: * version 2 for more details (a copy is included in the LICENSE file that
duke@1: * accompanied this code).
duke@1: *
duke@1: * You should have received a copy of the GNU General Public License version
duke@1: * 2 along with this work; if not, write to the Free Software Foundation,
duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1: *
duke@1: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1: * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1: * have any questions.
duke@1: */
duke@1:
duke@1: package com.sun.tools.javadoc;
duke@1:
duke@1: import com.sun.javadoc.*;
duke@1:
duke@1: /**
duke@1: * Represents a @throws or @exception documentation tag.
duke@1: * Parses and holds the exception name and exception comment.
duke@1: * The exception name my be the name of a type variable.
duke@1: * Note: @exception is a backwards compatible synonymy for @throws.
duke@1: *
duke@1: * @author Robert Field
duke@1: * @author Atul M Dambalkar
duke@1: * @see ExecutableMemberDocImpl#throwsTags()
duke@1: *
duke@1: */
duke@1: class ThrowsTagImpl extends TagImpl implements ThrowsTag {
duke@1:
duke@1: private final String exceptionName;
duke@1: private final String exceptionComment;
duke@1:
duke@1: ThrowsTagImpl(DocImpl holder, String name, String text) {
duke@1: super(holder, name, text);
duke@1: String[] sa = divideAtWhite();
duke@1: exceptionName = sa[0];
duke@1: exceptionComment = sa[1];
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the exception name.
duke@1: */
duke@1: public String exceptionName() {
duke@1: return exceptionName;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the exception comment.
duke@1: */
duke@1: public String exceptionComment() {
duke@1: return exceptionComment;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the exception as a ClassDocImpl.
duke@1: */
duke@1: public ClassDoc exception() {
duke@1: ClassDocImpl exceptionClass;
duke@1: if (!(holder instanceof ExecutableMemberDoc)) {
duke@1: exceptionClass = null;
duke@1: } else {
duke@1: ExecutableMemberDocImpl emd = (ExecutableMemberDocImpl)holder;
duke@1: ClassDocImpl con = (ClassDocImpl)emd.containingClass();
duke@1: exceptionClass = (ClassDocImpl)con.findClass(exceptionName);
duke@1: }
duke@1: return exceptionClass;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the type that represents the exception.
duke@1: * This may be a ClassDoc
or a TypeVariable
.
duke@1: */
duke@1: public Type exceptionType() {
duke@1: //###(gj) TypeVariable not yet supported.
duke@1: return exception();
duke@1: }
duke@1:
duke@1:
duke@1: /**
duke@1: * Return the kind of this tag. Always "@throws" for instances
duke@1: * of ThrowsTagImpl.
duke@1: */
duke@1: public String kind() {
duke@1: return "@throws";
duke@1: }
duke@1:
duke@1: /**
duke@1: * For the exception comment with embedded @link tags return the array of
duke@1: * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).
duke@1: *
duke@1: * @return TagImpl[] Array of tags with inline SeeTagImpls.
duke@1: * @see TagImpl#inlineTagImpls()
duke@1: * @see ParamTagImpl#inlineTagImpls()
duke@1: */
duke@1: public Tag[] inlineTags() {
duke@1: return Comment.getInlineTags(holder, exceptionComment());
duke@1: }
duke@1: }