duke@1: /* jjg@1724: * Copyright (c) 2001, 2013, 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.*; jjg@1751: import com.sun.tools.doclets.internal.toolkit.Content; 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: * jjg@1359: *
This is NOT part of any supported API.
jjg@1359: * If you write code that depends on this, you do so at your own risk.
jjg@1359: * This code and its internal interfaces are subject to change or
jjg@1359: * deletion without notice.
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 {
jjg@1724: exception = input.element.containingClass().findClass(input.tagId);
duke@1: }
duke@1:
jjg@1724: ThrowsTag[] tags = ((MethodDoc)input.element).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())))) {
jjg@1724: output.holder = input.element;
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: */
jjg@1751: private Content linkToUndocumentedDeclaredExceptions(
jjg@74: Type[] declaredExceptionTypes, SetTag
s representing this custom
duke@1: * tag, return its string representation.
duke@1: * @param throwTags the array of ThrowsTag
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.
jjg@1751: * @return the Content representation of this Tag
.
duke@1: */
jjg@1751: protected Content throwsTagsOutput(ThrowsTag[] throwTags,
jjg@74: TagletWriter writer, Set