author | briangoetz |
Wed, 18 Dec 2013 16:05:18 -0500 | |
changeset 22163 | 3651128c74eb |
parent 22159 | 682da512ec17 |
child 25454 | 376a52c9540c |
permissions | -rw-r--r-- |
10 | 1 |
/* |
17547
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
14260
diff
changeset
|
2 |
* Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. |
10 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5520 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
10 | 24 |
*/ |
25 |
||
26 |
package com.sun.tools.doclets.internal.toolkit.taglets; |
|
27 |
||
14258 | 28 |
import java.util.*; |
29 |
||
10 | 30 |
import com.sun.javadoc.*; |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
31 |
import com.sun.tools.doclets.internal.toolkit.Content; |
10 | 32 |
import com.sun.tools.doclets.internal.toolkit.util.*; |
33 |
||
34 |
/** |
|
35 |
* A taglet that represents the @throws tag. |
|
36 |
* |
|
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
37 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
38 |
* If you write code that depends on this, you do so at your own risk. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
39 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
40 |
* deletion without notice.</b> |
10 | 41 |
* |
42 |
* @author Jamie Ho |
|
43 |
* @since 1.4 |
|
44 |
*/ |
|
45 |
public class ThrowsTaglet extends BaseExecutableMemberTaglet |
|
46 |
implements InheritableTaglet { |
|
47 |
||
48 |
public ThrowsTaglet() { |
|
49 |
name = "throws"; |
|
50 |
} |
|
51 |
||
52 |
/** |
|
53 |
* {@inheritDoc} |
|
54 |
*/ |
|
55 |
public void inherit(DocFinder.Input input, DocFinder.Output output) { |
|
56 |
ClassDoc exception; |
|
57 |
if (input.tagId == null) { |
|
58 |
ThrowsTag throwsTag = (ThrowsTag) input.tag; |
|
59 |
exception = throwsTag.exception(); |
|
60 |
input.tagId = exception == null ? |
|
61 |
throwsTag.exceptionName() : |
|
62 |
throwsTag.exception().qualifiedName(); |
|
63 |
} else { |
|
17547
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
14260
diff
changeset
|
64 |
exception = input.element.containingClass().findClass(input.tagId); |
10 | 65 |
} |
66 |
||
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
67 |
for (ThrowsTag tag : ((MethodDoc)input.element).throwsTags()) { |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
68 |
if (input.tagId.equals(tag.exceptionName()) || |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
69 |
(tag.exception() != null && |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
70 |
(input.tagId.equals(tag.exception().qualifiedName())))) { |
17547
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
14260
diff
changeset
|
71 |
output.holder = input.element; |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
72 |
output.holderTag = tag; |
10 | 73 |
output.inlineTags = input.isFirstSentence ? |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
74 |
tag.firstSentenceTags() : tag.inlineTags(); |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
75 |
output.tagList.add(tag); |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
76 |
} else if (exception != null && tag.exception() != null && |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
77 |
tag.exception().subclassOf(exception)) { |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
78 |
output.tagList.add(tag); |
10 | 79 |
} |
80 |
} |
|
81 |
} |
|
82 |
||
83 |
/** |
|
84 |
* Add links for exceptions that are declared but not documented. |
|
85 |
*/ |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
86 |
private Content linkToUndocumentedDeclaredExceptions( |
868 | 87 |
Type[] declaredExceptionTypes, Set<String> alreadyDocumented, |
10 | 88 |
TagletWriter writer) { |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
89 |
Content result = writer.getOutputInstance(); |
10 | 90 |
//Add links to the exceptions declared but not documented. |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
91 |
for (Type declaredExceptionType : declaredExceptionTypes) { |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
92 |
if (declaredExceptionType.asClassDoc() != null && |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
93 |
!alreadyDocumented.contains( |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
94 |
declaredExceptionType.asClassDoc().name()) && |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
95 |
!alreadyDocumented.contains( |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
96 |
declaredExceptionType.asClassDoc().qualifiedName())) { |
10 | 97 |
if (alreadyDocumented.size() == 0) { |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
98 |
result.addContent(writer.getThrowsHeader()); |
10 | 99 |
} |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
100 |
result.addContent(writer.throwsTagOutput(declaredExceptionType)); |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
101 |
alreadyDocumented.add(declaredExceptionType.asClassDoc().name()); |
10 | 102 |
} |
103 |
} |
|
104 |
return result; |
|
105 |
} |
|
106 |
||
107 |
/** |
|
108 |
* Inherit throws documentation for exceptions that were declared but not |
|
109 |
* documented. |
|
110 |
*/ |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
111 |
private Content inheritThrowsDocumentation(Doc holder, |
868 | 112 |
Type[] declaredExceptionTypes, Set<String> alreadyDocumented, |
10 | 113 |
TagletWriter writer) { |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
114 |
Content result = writer.getOutputInstance(); |
10 | 115 |
if (holder instanceof MethodDoc) { |
22163 | 116 |
Set<Tag> declaredExceptionTags = new LinkedHashSet<>(); |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
117 |
for (Type declaredExceptionType : declaredExceptionTypes) { |
10 | 118 |
DocFinder.Output inheritedDoc = |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
119 |
DocFinder.search(new DocFinder.Input((MethodDoc) holder, this, |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
120 |
declaredExceptionType.typeName())); |
10 | 121 |
if (inheritedDoc.tagList.size() == 0) { |
122 |
inheritedDoc = DocFinder.search(new DocFinder.Input( |
|
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
123 |
(MethodDoc) holder, this, |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
124 |
declaredExceptionType.qualifiedTypeName())); |
10 | 125 |
} |
126 |
declaredExceptionTags.addAll(inheritedDoc.tagList); |
|
127 |
} |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
128 |
result.addContent(throwsTagsOutput( |
868 | 129 |
declaredExceptionTags.toArray(new ThrowsTag[] {}), |
10 | 130 |
writer, alreadyDocumented, false)); |
131 |
} |
|
132 |
return result; |
|
133 |
} |
|
134 |
||
135 |
/** |
|
136 |
* {@inheritDoc} |
|
137 |
*/ |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
138 |
public Content getTagletOutput(Doc holder, TagletWriter writer) { |
10 | 139 |
ExecutableMemberDoc execHolder = (ExecutableMemberDoc) holder; |
140 |
ThrowsTag[] tags = execHolder.throwsTags(); |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
141 |
Content result = writer.getOutputInstance(); |
22163 | 142 |
HashSet<String> alreadyDocumented = new HashSet<>(); |
10 | 143 |
if (tags.length > 0) { |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
144 |
result.addContent(throwsTagsOutput( |
10 | 145 |
execHolder.throwsTags(), writer, alreadyDocumented, true)); |
146 |
} |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
147 |
result.addContent(inheritThrowsDocumentation(holder, |
10 | 148 |
execHolder.thrownExceptionTypes(), alreadyDocumented, writer)); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
149 |
result.addContent(linkToUndocumentedDeclaredExceptions( |
10 | 150 |
execHolder.thrownExceptionTypes(), alreadyDocumented, writer)); |
151 |
return result; |
|
152 |
} |
|
153 |
||
154 |
||
155 |
/** |
|
156 |
* Given an array of <code>Tag</code>s representing this custom |
|
157 |
* tag, return its string representation. |
|
158 |
* @param throwTags the array of <code>ThrowsTag</code>s to convert. |
|
159 |
* @param writer the TagletWriter that will write this tag. |
|
160 |
* @param alreadyDocumented the set of exceptions that have already |
|
161 |
* been documented. |
|
162 |
* @param allowDups True if we allow duplicate throws tags to be documented. |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
163 |
* @return the Content representation of this <code>Tag</code>. |
10 | 164 |
*/ |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
165 |
protected Content throwsTagsOutput(ThrowsTag[] throwTags, |
868 | 166 |
TagletWriter writer, Set<String> alreadyDocumented, boolean allowDups) { |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
167 |
Content result = writer.getOutputInstance(); |
10 | 168 |
if (throwTags.length > 0) { |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
169 |
for (ThrowsTag tt : throwTags) { |
10 | 170 |
ClassDoc cd = tt.exception(); |
171 |
if ((!allowDups) && (alreadyDocumented.contains(tt.exceptionName()) || |
|
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
172 |
(cd != null && alreadyDocumented.contains(cd.qualifiedName())))) { |
10 | 173 |
continue; |
174 |
} |
|
175 |
if (alreadyDocumented.size() == 0) { |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
176 |
result.addContent(writer.getThrowsHeader()); |
10 | 177 |
} |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
178 |
result.addContent(writer.throwsTagOutput(tt)); |
10 | 179 |
alreadyDocumented.add(cd != null ? |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17574
diff
changeset
|
180 |
cd.qualifiedName() : tt.exceptionName()); |
10 | 181 |
} |
182 |
} |
|
183 |
return result; |
|
184 |
} |
|
185 |
} |