diff -r 000000000000 -r 9a66ca7c79fa src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/ThrowsTaglet.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/ThrowsTaglet.java Sat Dec 01 00:00:00 2007 +0000
@@ -0,0 +1,184 @@
+/*
+ * Copyright 2001-2004 Sun Microsystems, Inc. All Rights Reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Sun designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Sun in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ */
+
+package com.sun.tools.doclets.internal.toolkit.taglets;
+
+import com.sun.javadoc.*;
+import com.sun.tools.doclets.internal.toolkit.util.*;
+import java.util.*;
+
+/**
+ * A taglet that represents the @throws tag.
+ *
+ * This code is not part of an API.
+ * It is implementation that is subject to change.
+ * Do not use it as an API
+ *
+ * @author Jamie Ho
+ * @since 1.4
+ */
+public class ThrowsTaglet extends BaseExecutableMemberTaglet
+ implements InheritableTaglet {
+
+ public ThrowsTaglet() {
+ name = "throws";
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void inherit(DocFinder.Input input, DocFinder.Output output) {
+ ClassDoc exception;
+ if (input.tagId == null) {
+ ThrowsTag throwsTag = (ThrowsTag) input.tag;
+ exception = throwsTag.exception();
+ input.tagId = exception == null ?
+ throwsTag.exceptionName() :
+ throwsTag.exception().qualifiedName();
+ } else {
+ exception = input.method.containingClass().findClass(input.tagId);
+ }
+
+ ThrowsTag[] tags = input.method.throwsTags();
+ for (int i = 0; i < tags.length; i++) {
+ if (input.tagId.equals(tags[i].exceptionName()) ||
+ (tags[i].exception() != null &&
+ (input.tagId.equals(tags[i].exception().qualifiedName())))) {
+ output.holder = input.method;
+ output.holderTag = tags[i];
+ output.inlineTags = input.isFirstSentence ?
+ tags[i].firstSentenceTags() : tags[i].inlineTags();
+ output.tagList.add(tags[i]);
+ } else if (exception != null && tags[i].exception() != null &&
+ tags[i].exception().subclassOf(exception)) {
+ output.tagList.add(tags[i]);
+ }
+ }
+ }
+
+ /**
+ * Add links for exceptions that are declared but not documented.
+ */
+ private TagletOutput linkToUndocumentedDeclaredExceptions(
+ Type[] declaredExceptionTypes, Set alreadyDocumented,
+ TagletWriter writer) {
+ TagletOutput result = writer.getOutputInstance();
+ //Add links to the exceptions declared but not documented.
+ for (int i = 0; i < declaredExceptionTypes.length; i++) {
+ if (declaredExceptionTypes[i].asClassDoc() != null &&
+ ! alreadyDocumented.contains(
+ declaredExceptionTypes[i].asClassDoc().name()) &&
+ ! alreadyDocumented.contains(
+ declaredExceptionTypes[i].asClassDoc().qualifiedName())) {
+ if (alreadyDocumented.size() == 0) {
+ result.appendOutput(writer.getThrowsHeader());
+ }
+ result.appendOutput(writer.throwsTagOutput(declaredExceptionTypes[i]));
+ alreadyDocumented.add(declaredExceptionTypes[i].asClassDoc().name());
+ }
+ }
+ return result;
+ }
+
+ /**
+ * Inherit throws documentation for exceptions that were declared but not
+ * documented.
+ */
+ private TagletOutput inheritThrowsDocumentation(Doc holder,
+ Type[] declaredExceptionTypes, Set alreadyDocumented,
+ TagletWriter writer) {
+ TagletOutput result = writer.getOutputInstance();
+ if (holder instanceof MethodDoc) {
+ Set declaredExceptionTags = new LinkedHashSet();
+ for (int j = 0; j < declaredExceptionTypes.length; j++) {
+ DocFinder.Output inheritedDoc =
+ DocFinder.search(new DocFinder.Input((MethodDoc) holder, this,
+ declaredExceptionTypes[j].typeName()));
+ if (inheritedDoc.tagList.size() == 0) {
+ inheritedDoc = DocFinder.search(new DocFinder.Input(
+ (MethodDoc) holder, this,
+ declaredExceptionTypes[j].qualifiedTypeName()));
+ }
+ declaredExceptionTags.addAll(inheritedDoc.tagList);
+ }
+ result.appendOutput(throwsTagsOutput(
+ (ThrowsTag[]) declaredExceptionTags.toArray(new ThrowsTag[] {}),
+ writer, alreadyDocumented, false));
+ }
+ return result;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) {
+ ExecutableMemberDoc execHolder = (ExecutableMemberDoc) holder;
+ ThrowsTag[] tags = execHolder.throwsTags();
+ TagletOutput result = writer.getOutputInstance();
+ HashSet alreadyDocumented = new HashSet();
+ if (tags.length > 0) {
+ result.appendOutput(throwsTagsOutput(
+ execHolder.throwsTags(), writer, alreadyDocumented, true));
+ }
+ result.appendOutput(inheritThrowsDocumentation(holder,
+ execHolder.thrownExceptionTypes(), alreadyDocumented, writer));
+ result.appendOutput(linkToUndocumentedDeclaredExceptions(
+ execHolder.thrownExceptionTypes(), alreadyDocumented, writer));
+ return result;
+ }
+
+
+ /**
+ * Given an array of Tags representing this custom
+ * tag, return its string representation.
+ * @param throwTags the array of ThrowsTags to convert.
+ * @param writer the TagletWriter that will write this tag.
+ * @param alreadyDocumented the set of exceptions that have already
+ * been documented.
+ * @param allowDups True if we allow duplicate throws tags to be documented.
+ * @return the TagletOutput representation of this Tag.
+ */
+ protected TagletOutput throwsTagsOutput(ThrowsTag[] throwTags,
+ TagletWriter writer, Set alreadyDocumented, boolean allowDups) {
+ TagletOutput result = writer.getOutputInstance();
+ if (throwTags.length > 0) {
+ for (int i = 0; i < throwTags.length; ++i) {
+ ThrowsTag tt = throwTags[i];
+ ClassDoc cd = tt.exception();
+ if ((!allowDups) && (alreadyDocumented.contains(tt.exceptionName()) ||
+ (cd != null && alreadyDocumented.contains(cd.qualifiedName())))) {
+ continue;
+ }
+ if (alreadyDocumented.size() == 0) {
+ result.appendOutput(writer.getThrowsHeader());
+ }
+ result.appendOutput(writer.throwsTagOutput(tt));
+ alreadyDocumented.add(cd != null ?
+ cd.qualifiedName() : tt.exceptionName());
+ }
+ }
+ return result;
+ }
+}