duke@1: /*
jjg@1357:  * Copyright (c) 2001, 2012, Oracle and/or its affiliates. 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
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle 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:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.internal.toolkit.taglets;
duke@1: 
jjg@1357: import java.util.*;
jjg@1357: 
duke@1: import com.sun.javadoc.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1: 
duke@1: /**
duke@1:  * A taglet that represents the @throws tag.
duke@1:  *
duke@1:  * This code is not part of an API.
duke@1:  * It is implementation that is subject to change.
duke@1:  * Do not use it as an API
duke@1:  *
duke@1:  * @author Jamie Ho
duke@1:  * @since 1.4
duke@1:  */
duke@1: public class ThrowsTaglet extends BaseExecutableMemberTaglet
duke@1:     implements InheritableTaglet {
duke@1: 
duke@1:     public ThrowsTaglet() {
duke@1:         name = "throws";
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void inherit(DocFinder.Input input, DocFinder.Output output) {
duke@1:         ClassDoc exception;
duke@1:         if (input.tagId == null) {
duke@1:             ThrowsTag throwsTag = (ThrowsTag) input.tag;
duke@1:             exception = throwsTag.exception();
duke@1:             input.tagId = exception == null ?
duke@1:                 throwsTag.exceptionName() :
duke@1:                 throwsTag.exception().qualifiedName();
duke@1:         } else {
duke@1:             exception = input.method.containingClass().findClass(input.tagId);
duke@1:         }
duke@1: 
duke@1:         ThrowsTag[] tags = input.method.throwsTags();
duke@1:         for (int i = 0; i < tags.length; i++) {
duke@1:             if (input.tagId.equals(tags[i].exceptionName()) ||
duke@1:                 (tags[i].exception() != null &&
duke@1:                     (input.tagId.equals(tags[i].exception().qualifiedName())))) {
duke@1:                 output.holder = input.method;
duke@1:                 output.holderTag = tags[i];
duke@1:                 output.inlineTags = input.isFirstSentence ?
duke@1:                     tags[i].firstSentenceTags() : tags[i].inlineTags();
duke@1:                 output.tagList.add(tags[i]);
duke@1:             } else if (exception != null && tags[i].exception() != null &&
duke@1:                     tags[i].exception().subclassOf(exception)) {
duke@1:                 output.tagList.add(tags[i]);
duke@1:             }
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Add links for exceptions that are declared but not documented.
duke@1:      */
duke@1:     private TagletOutput linkToUndocumentedDeclaredExceptions(
jjg@74:             Type[] declaredExceptionTypes, Set<String> alreadyDocumented,
duke@1:             TagletWriter writer) {
duke@1:         TagletOutput result = writer.getOutputInstance();
duke@1:         //Add links to the exceptions declared but not documented.
duke@1:         for (int i = 0; i < declaredExceptionTypes.length; i++) {
duke@1:             if (declaredExceptionTypes[i].asClassDoc() != null &&
duke@1:                 ! alreadyDocumented.contains(
duke@1:                         declaredExceptionTypes[i].asClassDoc().name()) &&
duke@1:                 ! alreadyDocumented.contains(
duke@1:                     declaredExceptionTypes[i].asClassDoc().qualifiedName())) {
duke@1:                 if (alreadyDocumented.size() == 0) {
duke@1:                     result.appendOutput(writer.getThrowsHeader());
duke@1:                 }
duke@1:                 result.appendOutput(writer.throwsTagOutput(declaredExceptionTypes[i]));
duke@1:                 alreadyDocumented.add(declaredExceptionTypes[i].asClassDoc().name());
duke@1:             }
duke@1:         }
duke@1:         return result;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Inherit throws documentation for exceptions that were declared but not
duke@1:      * documented.
duke@1:      */
duke@1:     private TagletOutput inheritThrowsDocumentation(Doc holder,
jjg@74:             Type[] declaredExceptionTypes, Set<String> alreadyDocumented,
duke@1:             TagletWriter writer) {
duke@1:         TagletOutput result = writer.getOutputInstance();
duke@1:         if (holder instanceof MethodDoc) {
jjg@74:             Set<Tag> declaredExceptionTags = new LinkedHashSet<Tag>();
duke@1:             for (int j = 0; j < declaredExceptionTypes.length; j++) {
duke@1:                 DocFinder.Output inheritedDoc =
duke@1:                     DocFinder.search(new DocFinder.Input((MethodDoc) holder, this,
duke@1:                         declaredExceptionTypes[j].typeName()));
duke@1:                 if (inheritedDoc.tagList.size() == 0) {
duke@1:                     inheritedDoc = DocFinder.search(new DocFinder.Input(
duke@1:                         (MethodDoc) holder, this,
duke@1:                         declaredExceptionTypes[j].qualifiedTypeName()));
duke@1:                 }
duke@1:                 declaredExceptionTags.addAll(inheritedDoc.tagList);
duke@1:             }
duke@1:             result.appendOutput(throwsTagsOutput(
jjg@74:                 declaredExceptionTags.toArray(new ThrowsTag[] {}),
duke@1:                 writer, alreadyDocumented, false));
duke@1:         }
duke@1:         return result;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) {
duke@1:         ExecutableMemberDoc execHolder = (ExecutableMemberDoc) holder;
duke@1:         ThrowsTag[] tags = execHolder.throwsTags();
duke@1:         TagletOutput result = writer.getOutputInstance();
jjg@74:         HashSet<String> alreadyDocumented = new HashSet<String>();
duke@1:         if (tags.length > 0) {
duke@1:             result.appendOutput(throwsTagsOutput(
duke@1:                 execHolder.throwsTags(), writer, alreadyDocumented, true));
duke@1:         }
duke@1:         result.appendOutput(inheritThrowsDocumentation(holder,
duke@1:             execHolder.thrownExceptionTypes(), alreadyDocumented, writer));
duke@1:         result.appendOutput(linkToUndocumentedDeclaredExceptions(
duke@1:             execHolder.thrownExceptionTypes(), alreadyDocumented, writer));
duke@1:         return result;
duke@1:     }
duke@1: 
duke@1: 
duke@1:     /**
duke@1:      * Given an array of <code>Tag</code>s representing this custom
duke@1:      * tag, return its string representation.
duke@1:      * @param throwTags the array of <code>ThrowsTag</code>s to convert.
duke@1:      * @param writer the TagletWriter that will write this tag.
duke@1:      * @param alreadyDocumented the set of exceptions that have already
duke@1:      *        been documented.
duke@1:      * @param allowDups True if we allow duplicate throws tags to be documented.
duke@1:      * @return the TagletOutput representation of this <code>Tag</code>.
duke@1:      */
duke@1:     protected TagletOutput throwsTagsOutput(ThrowsTag[] throwTags,
jjg@74:         TagletWriter writer, Set<String> alreadyDocumented, boolean allowDups) {
duke@1:         TagletOutput result = writer.getOutputInstance();
duke@1:         if (throwTags.length > 0) {
duke@1:             for (int i = 0; i < throwTags.length; ++i) {
duke@1:                 ThrowsTag tt = throwTags[i];
duke@1:                 ClassDoc cd = tt.exception();
duke@1:                 if ((!allowDups) && (alreadyDocumented.contains(tt.exceptionName()) ||
duke@1:                     (cd != null && alreadyDocumented.contains(cd.qualifiedName())))) {
duke@1:                     continue;
duke@1:                 }
duke@1:                 if (alreadyDocumented.size() == 0) {
duke@1:                     result.appendOutput(writer.getThrowsHeader());
duke@1:                 }
duke@1:                 result.appendOutput(writer.throwsTagOutput(tt));
duke@1:                 alreadyDocumented.add(cd != null ?
duke@1:                     cd.qualifiedName() : tt.exceptionName());
duke@1:             }
duke@1:         }
duke@1:         return result;
duke@1:     }
duke@1: }