001: /*
002: * Copyright 2001-2004 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package com.sun.tools.doclets.internal.toolkit.taglets;
027:
028: import com.sun.javadoc.*;
029: import com.sun.tools.doclets.internal.toolkit.util.*;
030: import java.util.*;
031:
032: /**
033: * A taglet that represents the @throws tag.
034: *
035: * This code is not part of an API.
036: * It is implementation that is subject to change.
037: * Do not use it as an API
038: *
039: * @author Jamie Ho
040: * @since 1.4
041: */
042: public class ThrowsTaglet extends BaseExecutableMemberTaglet implements
043: InheritableTaglet {
044:
045: public ThrowsTaglet() {
046: name = "throws";
047: }
048:
049: /**
050: * {@inheritDoc}
051: */
052: public void inherit(DocFinder.Input input, DocFinder.Output output) {
053: ClassDoc exception;
054: if (input.tagId == null) {
055: ThrowsTag throwsTag = (ThrowsTag) input.tag;
056: exception = throwsTag.exception();
057: input.tagId = exception == null ? throwsTag.exceptionName()
058: : throwsTag.exception().qualifiedName();
059: } else {
060: exception = input.method.containingClass().findClass(
061: input.tagId);
062: }
063:
064: ThrowsTag[] tags = input.method.throwsTags();
065: for (int i = 0; i < tags.length; i++) {
066: if (input.tagId.equals(tags[i].exceptionName())
067: || (tags[i].exception() != null && (input.tagId
068: .equals(tags[i].exception().qualifiedName())))) {
069: output.holder = input.method;
070: output.holderTag = tags[i];
071: output.inlineTags = input.isFirstSentence ? tags[i]
072: .firstSentenceTags() : tags[i].inlineTags();
073: output.tagList.add(tags[i]);
074: } else if (exception != null && tags[i].exception() != null
075: && tags[i].exception().subclassOf(exception)) {
076: output.tagList.add(tags[i]);
077: }
078: }
079: }
080:
081: /**
082: * Add links for exceptions that are declared but not documented.
083: */
084: private TagletOutput linkToUndocumentedDeclaredExceptions(
085: Type[] declaredExceptionTypes, Set alreadyDocumented,
086: TagletWriter writer) {
087: TagletOutput result = writer.getOutputInstance();
088: //Add links to the exceptions declared but not documented.
089: for (int i = 0; i < declaredExceptionTypes.length; i++) {
090: if (declaredExceptionTypes[i].asClassDoc() != null
091: && !alreadyDocumented
092: .contains(declaredExceptionTypes[i]
093: .asClassDoc().name())
094: && !alreadyDocumented
095: .contains(declaredExceptionTypes[i]
096: .asClassDoc().qualifiedName())) {
097: if (alreadyDocumented.size() == 0) {
098: result.appendOutput(writer.getThrowsHeader());
099: }
100: result.appendOutput(writer
101: .throwsTagOutput(declaredExceptionTypes[i]));
102: alreadyDocumented.add(declaredExceptionTypes[i]
103: .asClassDoc().name());
104: }
105: }
106: return result;
107: }
108:
109: /**
110: * Inherit throws documentation for exceptions that were declared but not
111: * documented.
112: */
113: private TagletOutput inheritThrowsDocumentation(Doc holder,
114: Type[] declaredExceptionTypes, Set alreadyDocumented,
115: TagletWriter writer) {
116: TagletOutput result = writer.getOutputInstance();
117: if (holder instanceof MethodDoc) {
118: Set declaredExceptionTags = new LinkedHashSet();
119: for (int j = 0; j < declaredExceptionTypes.length; j++) {
120: DocFinder.Output inheritedDoc = DocFinder
121: .search(new DocFinder.Input((MethodDoc) holder,
122: this , declaredExceptionTypes[j]
123: .typeName()));
124: if (inheritedDoc.tagList.size() == 0) {
125: inheritedDoc = DocFinder
126: .search(new DocFinder.Input(
127: (MethodDoc) holder, this ,
128: declaredExceptionTypes[j]
129: .qualifiedTypeName()));
130: }
131: declaredExceptionTags.addAll(inheritedDoc.tagList);
132: }
133: result.appendOutput(throwsTagsOutput(
134: (ThrowsTag[]) declaredExceptionTags
135: .toArray(new ThrowsTag[] {}), writer,
136: alreadyDocumented, false));
137: }
138: return result;
139: }
140:
141: /**
142: * {@inheritDoc}
143: */
144: public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) {
145: ExecutableMemberDoc execHolder = (ExecutableMemberDoc) holder;
146: ThrowsTag[] tags = execHolder.throwsTags();
147: TagletOutput result = writer.getOutputInstance();
148: HashSet alreadyDocumented = new HashSet();
149: if (tags.length > 0) {
150: result.appendOutput(throwsTagsOutput(execHolder
151: .throwsTags(), writer, alreadyDocumented, true));
152: }
153: result.appendOutput(inheritThrowsDocumentation(holder,
154: execHolder.thrownExceptionTypes(), alreadyDocumented,
155: writer));
156: result.appendOutput(linkToUndocumentedDeclaredExceptions(
157: execHolder.thrownExceptionTypes(), alreadyDocumented,
158: writer));
159: return result;
160: }
161:
162: /**
163: * Given an array of <code>Tag</code>s representing this custom
164: * tag, return its string representation.
165: * @param throwTags the array of <code>ThrowsTag</code>s to convert.
166: * @param writer the TagletWriter that will write this tag.
167: * @param alreadyDocumented the set of exceptions that have already
168: * been documented.
169: * @param allowDups True if we allow duplicate throws tags to be documented.
170: * @return the TagletOutput representation of this <code>Tag</code>.
171: */
172: protected TagletOutput throwsTagsOutput(ThrowsTag[] throwTags,
173: TagletWriter writer, Set alreadyDocumented,
174: boolean allowDups) {
175: TagletOutput result = writer.getOutputInstance();
176: if (throwTags.length > 0) {
177: for (int i = 0; i < throwTags.length; ++i) {
178: ThrowsTag tt = throwTags[i];
179: ClassDoc cd = tt.exception();
180: if ((!allowDups)
181: && (alreadyDocumented.contains(tt
182: .exceptionName()) || (cd != null && alreadyDocumented
183: .contains(cd.qualifiedName())))) {
184: continue;
185: }
186: if (alreadyDocumented.size() == 0) {
187: result.appendOutput(writer.getThrowsHeader());
188: }
189: result.appendOutput(writer.throwsTagOutput(tt));
190: alreadyDocumented.add(cd != null ? cd.qualifiedName()
191: : tt.exceptionName());
192: }
193: }
194: return result;
195: }
196: }
|