aoqi@0: /*
aoqi@0:  * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclets.internal.toolkit.taglets;
aoqi@0: 
aoqi@0: import java.util.*;
aoqi@0: 
aoqi@0: import com.sun.javadoc.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.Content;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * A taglet that represents the @throws tag.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Jamie Ho
aoqi@0:  * @since 1.4
aoqi@0:  */
aoqi@0: public class ThrowsTaglet extends BaseExecutableMemberTaglet
aoqi@0:     implements InheritableTaglet {
aoqi@0: 
aoqi@0:     public ThrowsTaglet() {
aoqi@0:         name = "throws";
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public void inherit(DocFinder.Input input, DocFinder.Output output) {
aoqi@0:         ClassDoc exception;
aoqi@0:         if (input.tagId == null) {
aoqi@0:             ThrowsTag throwsTag = (ThrowsTag) input.tag;
aoqi@0:             exception = throwsTag.exception();
aoqi@0:             input.tagId = exception == null ?
aoqi@0:                 throwsTag.exceptionName() :
aoqi@0:                 throwsTag.exception().qualifiedName();
aoqi@0:         } else {
aoqi@0:             exception = input.element.containingClass().findClass(input.tagId);
aoqi@0:         }
aoqi@0: 
aoqi@0:         ThrowsTag[] tags = ((MethodDoc)input.element).throwsTags();
aoqi@0:         for (int i = 0; i < tags.length; i++) {
aoqi@0:             if (input.tagId.equals(tags[i].exceptionName()) ||
aoqi@0:                 (tags[i].exception() != null &&
aoqi@0:                     (input.tagId.equals(tags[i].exception().qualifiedName())))) {
aoqi@0:                 output.holder = input.element;
aoqi@0:                 output.holderTag = tags[i];
aoqi@0:                 output.inlineTags = input.isFirstSentence ?
aoqi@0:                     tags[i].firstSentenceTags() : tags[i].inlineTags();
aoqi@0:                 output.tagList.add(tags[i]);
aoqi@0:             } else if (exception != null && tags[i].exception() != null &&
aoqi@0:                     tags[i].exception().subclassOf(exception)) {
aoqi@0:                 output.tagList.add(tags[i]);
aoqi@0:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Add links for exceptions that are declared but not documented.
aoqi@0:      */
aoqi@0:     private Content linkToUndocumentedDeclaredExceptions(
aoqi@0:             Type[] declaredExceptionTypes, Set<String> alreadyDocumented,
aoqi@0:             TagletWriter writer) {
aoqi@0:         Content result = writer.getOutputInstance();
aoqi@0:         //Add links to the exceptions declared but not documented.
aoqi@0:         for (int i = 0; i < declaredExceptionTypes.length; i++) {
aoqi@0:             if (declaredExceptionTypes[i].asClassDoc() != null &&
aoqi@0:                 ! alreadyDocumented.contains(
aoqi@0:                         declaredExceptionTypes[i].asClassDoc().name()) &&
aoqi@0:                 ! alreadyDocumented.contains(
aoqi@0:                     declaredExceptionTypes[i].asClassDoc().qualifiedName())) {
aoqi@0:                 if (alreadyDocumented.size() == 0) {
aoqi@0:                     result.addContent(writer.getThrowsHeader());
aoqi@0:                 }
aoqi@0:                 result.addContent(writer.throwsTagOutput(declaredExceptionTypes[i]));
aoqi@0:                 alreadyDocumented.add(declaredExceptionTypes[i].asClassDoc().name());
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return result;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Inherit throws documentation for exceptions that were declared but not
aoqi@0:      * documented.
aoqi@0:      */
aoqi@0:     private Content inheritThrowsDocumentation(Doc holder,
aoqi@0:             Type[] declaredExceptionTypes, Set<String> alreadyDocumented,
aoqi@0:             TagletWriter writer) {
aoqi@0:         Content result = writer.getOutputInstance();
aoqi@0:         if (holder instanceof MethodDoc) {
aoqi@0:             Set<Tag> declaredExceptionTags = new LinkedHashSet<Tag>();
aoqi@0:             for (int j = 0; j < declaredExceptionTypes.length; j++) {
aoqi@0:                 DocFinder.Output inheritedDoc =
aoqi@0:                     DocFinder.search(new DocFinder.Input((MethodDoc) holder, this,
aoqi@0:                         declaredExceptionTypes[j].typeName()));
aoqi@0:                 if (inheritedDoc.tagList.size() == 0) {
aoqi@0:                     inheritedDoc = DocFinder.search(new DocFinder.Input(
aoqi@0:                         (MethodDoc) holder, this,
aoqi@0:                         declaredExceptionTypes[j].qualifiedTypeName()));
aoqi@0:                 }
aoqi@0:                 declaredExceptionTags.addAll(inheritedDoc.tagList);
aoqi@0:             }
aoqi@0:             result.addContent(throwsTagsOutput(
aoqi@0:                 declaredExceptionTags.toArray(new ThrowsTag[] {}),
aoqi@0:                 writer, alreadyDocumented, false));
aoqi@0:         }
aoqi@0:         return result;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public Content getTagletOutput(Doc holder, TagletWriter writer) {
aoqi@0:         ExecutableMemberDoc execHolder = (ExecutableMemberDoc) holder;
aoqi@0:         ThrowsTag[] tags = execHolder.throwsTags();
aoqi@0:         Content result = writer.getOutputInstance();
aoqi@0:         HashSet<String> alreadyDocumented = new HashSet<String>();
aoqi@0:         if (tags.length > 0) {
aoqi@0:             result.addContent(throwsTagsOutput(
aoqi@0:                 execHolder.throwsTags(), writer, alreadyDocumented, true));
aoqi@0:         }
aoqi@0:         result.addContent(inheritThrowsDocumentation(holder,
aoqi@0:             execHolder.thrownExceptionTypes(), alreadyDocumented, writer));
aoqi@0:         result.addContent(linkToUndocumentedDeclaredExceptions(
aoqi@0:             execHolder.thrownExceptionTypes(), alreadyDocumented, writer));
aoqi@0:         return result;
aoqi@0:     }
aoqi@0: 
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Given an array of <code>Tag</code>s representing this custom
aoqi@0:      * tag, return its string representation.
aoqi@0:      * @param throwTags the array of <code>ThrowsTag</code>s to convert.
aoqi@0:      * @param writer the TagletWriter that will write this tag.
aoqi@0:      * @param alreadyDocumented the set of exceptions that have already
aoqi@0:      *        been documented.
aoqi@0:      * @param allowDups True if we allow duplicate throws tags to be documented.
aoqi@0:      * @return the Content representation of this <code>Tag</code>.
aoqi@0:      */
aoqi@0:     protected Content throwsTagsOutput(ThrowsTag[] throwTags,
aoqi@0:         TagletWriter writer, Set<String> alreadyDocumented, boolean allowDups) {
aoqi@0:         Content result = writer.getOutputInstance();
aoqi@0:         if (throwTags.length > 0) {
aoqi@0:             for (int i = 0; i < throwTags.length; ++i) {
aoqi@0:                 ThrowsTag tt = throwTags[i];
aoqi@0:                 ClassDoc cd = tt.exception();
aoqi@0:                 if ((!allowDups) && (alreadyDocumented.contains(tt.exceptionName()) ||
aoqi@0:                     (cd != null && alreadyDocumented.contains(cd.qualifiedName())))) {
aoqi@0:                     continue;
aoqi@0:                 }
aoqi@0:                 if (alreadyDocumented.size() == 0) {
aoqi@0:                     result.addContent(writer.getThrowsHeader());
aoqi@0:                 }
aoqi@0:                 result.addContent(writer.throwsTagOutput(tt));
aoqi@0:                 alreadyDocumented.add(cd != null ?
aoqi@0:                     cd.qualifiedName() : tt.exceptionName());
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return result;
aoqi@0:     }
aoqi@0: }