author | jjg |
Fri, 18 Jun 2010 21:13:56 -0700 | |
changeset 5855 | 00d9c252e60c |
parent 5520 | 86e4b9a9da40 |
child 7614 | cfadc977ca75 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
5520 | 2 |
* Copyright (c) 2003, 2008, 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.builders; |
|
27 |
||
28 |
import com.sun.tools.doclets.internal.toolkit.util.*; |
|
29 |
import com.sun.tools.doclets.internal.toolkit.*; |
|
30 |
import com.sun.javadoc.*; |
|
31 |
import java.util.*; |
|
32 |
||
33 |
/** |
|
34 |
* Builds the member summary. |
|
35 |
* |
|
36 |
* This code is not part of an API. |
|
37 |
* It is implementation that is subject to change. |
|
38 |
* Do not use it as an API |
|
39 |
* |
|
40 |
* @author Jamie Ho |
|
41 |
* @since 1.5 |
|
42 |
*/ |
|
43 |
public class MemberSummaryBuilder extends AbstractMemberBuilder { |
|
44 |
||
45 |
/** |
|
46 |
* The XML root for this builder. |
|
47 |
*/ |
|
48 |
public static final String NAME = "MemberSummary"; |
|
49 |
||
50 |
/** |
|
51 |
* The visible members for the given class. |
|
52 |
*/ |
|
53 |
private VisibleMemberMap[] visibleMemberMaps; |
|
54 |
||
55 |
/** |
|
56 |
* The member summary writers for the given class. |
|
57 |
*/ |
|
58 |
private MemberSummaryWriter[] memberSummaryWriters; |
|
59 |
||
60 |
/** |
|
61 |
* The type being documented. |
|
62 |
*/ |
|
63 |
private ClassDoc classDoc; |
|
64 |
||
65 |
private MemberSummaryBuilder(Configuration configuration) { |
|
66 |
super(configuration); |
|
67 |
} |
|
68 |
||
69 |
/** |
|
70 |
* Construct a new MemberSummaryBuilder. |
|
71 |
* |
|
72 |
* @param classWriter the writer for the class whose members are being |
|
73 |
* summarized. |
|
74 |
* @param configuration the current configuration of the doclet. |
|
75 |
*/ |
|
76 |
public static MemberSummaryBuilder getInstance( |
|
77 |
ClassWriter classWriter, Configuration configuration) |
|
78 |
throws Exception { |
|
79 |
MemberSummaryBuilder builder = new MemberSummaryBuilder(configuration); |
|
80 |
builder.classDoc = classWriter.getClassDoc(); |
|
81 |
builder.init(classWriter); |
|
82 |
return builder; |
|
83 |
} |
|
84 |
||
85 |
/** |
|
86 |
* Construct a new MemberSummaryBuilder. |
|
87 |
* |
|
88 |
* @param annotationTypeWriter the writer for the class whose members are |
|
89 |
* being summarized. |
|
90 |
* @param configuration the current configuration of the doclet. |
|
91 |
*/ |
|
92 |
public static MemberSummaryBuilder getInstance( |
|
93 |
AnnotationTypeWriter annotationTypeWriter, Configuration configuration) |
|
94 |
throws Exception { |
|
95 |
MemberSummaryBuilder builder = new MemberSummaryBuilder(configuration); |
|
96 |
builder.classDoc = annotationTypeWriter.getAnnotationTypeDoc(); |
|
97 |
builder.init(annotationTypeWriter); |
|
98 |
return builder; |
|
99 |
} |
|
100 |
||
101 |
private void init(Object writer) throws Exception { |
|
102 |
visibleMemberMaps = |
|
103 |
new VisibleMemberMap[VisibleMemberMap.NUM_MEMBER_TYPES]; |
|
104 |
for (int i = 0; i < VisibleMemberMap.NUM_MEMBER_TYPES; i++) { |
|
105 |
visibleMemberMaps[i] = |
|
106 |
new VisibleMemberMap( |
|
107 |
classDoc, |
|
108 |
i, |
|
109 |
configuration.nodeprecated); |
|
110 |
} |
|
111 |
memberSummaryWriters = |
|
112 |
new MemberSummaryWriter[VisibleMemberMap.NUM_MEMBER_TYPES]; |
|
113 |
for (int i = 0; i < VisibleMemberMap.NUM_MEMBER_TYPES; i++) { |
|
114 |
if (classDoc.isAnnotationType()) { |
|
115 |
memberSummaryWriters[i] = |
|
116 |
visibleMemberMaps[i].noVisibleMembers()? |
|
117 |
null : |
|
118 |
configuration.getWriterFactory().getMemberSummaryWriter( |
|
119 |
(AnnotationTypeWriter) writer, i); |
|
120 |
} else { |
|
121 |
memberSummaryWriters[i] = |
|
122 |
visibleMemberMaps[i].noVisibleMembers()? |
|
123 |
null : |
|
124 |
configuration.getWriterFactory().getMemberSummaryWriter( |
|
125 |
(ClassWriter) writer, i); |
|
126 |
} |
|
127 |
} |
|
128 |
||
129 |
} |
|
130 |
||
131 |
/** |
|
132 |
* {@inheritDoc} |
|
133 |
*/ |
|
134 |
public String getName() { |
|
135 |
return NAME; |
|
136 |
} |
|
137 |
||
138 |
/** |
|
139 |
* Return the specified visible member map. |
|
140 |
* |
|
141 |
* @param type the type of visible member map to return. |
|
142 |
* @return the specified visible member map. |
|
143 |
* @throws ArrayIndexOutOfBoundsException when the type is invalid. |
|
144 |
* @see VisibleMemberMap |
|
145 |
*/ |
|
146 |
public VisibleMemberMap getVisibleMemberMap(int type) { |
|
147 |
return visibleMemberMaps[type]; |
|
148 |
} |
|
149 |
||
150 |
/** |
|
151 |
* Return the specified member summary writer. |
|
152 |
* |
|
153 |
* @param type the type of member summary writer to return. |
|
154 |
* @return the specified member summary writer. |
|
155 |
* @throws ArrayIndexOutOfBoundsException when the type is invalid. |
|
156 |
* @see VisibleMemberMap |
|
157 |
*/ |
|
158 |
public MemberSummaryWriter getMemberSummaryWriter(int type) { |
|
159 |
return memberSummaryWriters[type]; |
|
160 |
} |
|
161 |
||
162 |
/** |
|
163 |
* Returns a list of methods that will be documented for the given class. |
|
164 |
* This information can be used for doclet specific documentation |
|
165 |
* generation. |
|
166 |
* |
|
167 |
* @param classDoc the {@link ClassDoc} we want to check. |
|
168 |
* @param type the type of members to return. |
|
169 |
* @return a list of methods that will be documented. |
|
170 |
* @see VisibleMemberMap |
|
171 |
*/ |
|
1789
7ac8c0815000
6765045: Remove rawtypes warnings from langtools
mcimadamore
parents:
1264
diff
changeset
|
172 |
public List<ProgramElementDoc> members(int type) { |
10 | 173 |
return visibleMemberMaps[type].getLeafClassMembers(configuration); |
174 |
} |
|
175 |
||
176 |
/** |
|
177 |
* Return true it there are any members to summarize. |
|
178 |
* |
|
179 |
* @return true if there are any members to summarize. |
|
180 |
*/ |
|
181 |
public boolean hasMembersToDocument() { |
|
182 |
if (classDoc instanceof AnnotationTypeDoc) { |
|
183 |
return ((AnnotationTypeDoc) classDoc).elements().length > 0; |
|
184 |
} |
|
185 |
for (int i = 0; i < VisibleMemberMap.NUM_MEMBER_TYPES; i++) { |
|
186 |
VisibleMemberMap members = visibleMemberMaps[i]; |
|
187 |
if (!members.noVisibleMembers()) { |
|
188 |
return true; |
|
189 |
} |
|
190 |
} |
|
191 |
return false; |
|
192 |
} |
|
193 |
||
194 |
/** |
|
195 |
* Build the summary for the enum constants. |
|
196 |
*/ |
|
5855 | 197 |
public void buildEnumConstantsSummary(XMLNode node) { |
10 | 198 |
buildSummary( |
199 |
memberSummaryWriters[VisibleMemberMap.ENUM_CONSTANTS], |
|
200 |
visibleMemberMaps[VisibleMemberMap.ENUM_CONSTANTS]); |
|
201 |
} |
|
202 |
||
203 |
/** |
|
204 |
* Build the summary for the optional members. |
|
205 |
*/ |
|
5855 | 206 |
public void buildAnnotationTypeOptionalMemberSummary(XMLNode node) { |
10 | 207 |
buildSummary( |
208 |
memberSummaryWriters[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_OPTIONAL], |
|
209 |
visibleMemberMaps[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_OPTIONAL]); |
|
210 |
} |
|
211 |
||
212 |
/** |
|
213 |
* Build the summary for the optional members. |
|
214 |
*/ |
|
5855 | 215 |
public void buildAnnotationTypeRequiredMemberSummary(XMLNode node) { |
10 | 216 |
buildSummary( |
217 |
memberSummaryWriters[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED], |
|
218 |
visibleMemberMaps[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED]); |
|
219 |
} |
|
220 |
||
221 |
/** |
|
222 |
* Build the summary for the fields. |
|
223 |
*/ |
|
5855 | 224 |
public void buildFieldsSummary(XMLNode node) { |
10 | 225 |
buildSummary( |
226 |
memberSummaryWriters[VisibleMemberMap.FIELDS], |
|
227 |
visibleMemberMaps[VisibleMemberMap.FIELDS]); |
|
228 |
} |
|
229 |
||
230 |
/** |
|
231 |
* Build the inherited summary for the fields. |
|
232 |
*/ |
|
5855 | 233 |
public void buildFieldsInheritedSummary(XMLNode node) { |
10 | 234 |
buildInheritedSummary( |
235 |
memberSummaryWriters[VisibleMemberMap.FIELDS], |
|
236 |
visibleMemberMaps[VisibleMemberMap.FIELDS]); |
|
237 |
} |
|
238 |
||
239 |
/** |
|
240 |
* Build the summary for the nested classes. |
|
241 |
*/ |
|
5855 | 242 |
public void buildNestedClassesSummary(XMLNode node) { |
10 | 243 |
buildSummary( |
244 |
memberSummaryWriters[VisibleMemberMap.INNERCLASSES], |
|
245 |
visibleMemberMaps[VisibleMemberMap.INNERCLASSES]); |
|
246 |
} |
|
247 |
||
248 |
/** |
|
249 |
* Build the inherited summary for the nested classes. |
|
250 |
*/ |
|
5855 | 251 |
public void buildNestedClassesInheritedSummary(XMLNode node) { |
10 | 252 |
buildInheritedSummary( |
253 |
memberSummaryWriters[VisibleMemberMap.INNERCLASSES], |
|
254 |
visibleMemberMaps[VisibleMemberMap.INNERCLASSES]); |
|
255 |
} |
|
256 |
||
257 |
/** |
|
258 |
* Build the method summary. |
|
259 |
*/ |
|
5855 | 260 |
public void buildMethodsSummary(XMLNode node) { |
10 | 261 |
buildSummary( |
262 |
memberSummaryWriters[VisibleMemberMap.METHODS], |
|
263 |
visibleMemberMaps[VisibleMemberMap.METHODS]); |
|
264 |
} |
|
265 |
||
266 |
/** |
|
267 |
* Build the inherited method summary. |
|
268 |
*/ |
|
5855 | 269 |
public void buildMethodsInheritedSummary(XMLNode node) { |
10 | 270 |
buildInheritedSummary( |
271 |
memberSummaryWriters[VisibleMemberMap.METHODS], |
|
272 |
visibleMemberMaps[VisibleMemberMap.METHODS]); |
|
273 |
} |
|
274 |
||
275 |
/** |
|
276 |
* Build the constructor summary. |
|
277 |
*/ |
|
5855 | 278 |
public void buildConstructorsSummary(XMLNode node) { |
10 | 279 |
buildSummary( |
280 |
memberSummaryWriters[VisibleMemberMap.CONSTRUCTORS], |
|
281 |
visibleMemberMaps[VisibleMemberMap.CONSTRUCTORS]); |
|
282 |
} |
|
283 |
||
284 |
/** |
|
285 |
* Build the member summary for the given members. |
|
286 |
* |
|
287 |
* @param writer the summary writer to write the output. |
|
288 |
* @param visibleMemberMap the given members to summarize. |
|
289 |
*/ |
|
290 |
private void buildSummary(MemberSummaryWriter writer, |
|
291 |
VisibleMemberMap visibleMemberMap) { |
|
868 | 292 |
List<ProgramElementDoc> members = new ArrayList<ProgramElementDoc>(visibleMemberMap.getLeafClassMembers( |
10 | 293 |
configuration)); |
294 |
if (members.size() > 0) { |
|
295 |
Collections.sort(members); |
|
296 |
writer.writeMemberSummaryHeader(classDoc); |
|
297 |
for (int i = 0; i < members.size(); i++) { |
|
868 | 298 |
ProgramElementDoc member = members.get(i); |
10 | 299 |
Tag[] firstSentenceTags = member.firstSentenceTags(); |
300 |
if (member instanceof MethodDoc && firstSentenceTags.length == 0) { |
|
301 |
//Inherit comments from overriden or implemented method if |
|
302 |
//necessary. |
|
303 |
DocFinder.Output inheritedDoc = |
|
304 |
DocFinder.search(new DocFinder.Input((MethodDoc) member)); |
|
305 |
if (inheritedDoc.holder != null && |
|
306 |
inheritedDoc.holder.firstSentenceTags().length > 0) { |
|
307 |
firstSentenceTags = inheritedDoc.holder.firstSentenceTags(); |
|
308 |
} |
|
309 |
} |
|
310 |
writer.writeMemberSummary(classDoc, member, firstSentenceTags, |
|
311 |
i == 0, i == members.size() - 1); |
|
312 |
} |
|
313 |
writer.writeMemberSummaryFooter(classDoc); |
|
314 |
} |
|
315 |
} |
|
316 |
||
317 |
/** |
|
318 |
* Build the inherited member summary for the given methods. |
|
319 |
* |
|
320 |
* @param writer the writer for this member summary. |
|
321 |
* @param visibleMemberMap the map for the members to document. |
|
322 |
*/ |
|
323 |
private void buildInheritedSummary(MemberSummaryWriter writer, |
|
324 |
VisibleMemberMap visibleMemberMap) { |
|
1789
7ac8c0815000
6765045: Remove rawtypes warnings from langtools
mcimadamore
parents:
1264
diff
changeset
|
325 |
for (Iterator<ClassDoc> iter = visibleMemberMap.getVisibleClassesList().iterator(); |
10 | 326 |
iter.hasNext();) { |
1789
7ac8c0815000
6765045: Remove rawtypes warnings from langtools
mcimadamore
parents:
1264
diff
changeset
|
327 |
ClassDoc inhclass = iter.next(); |
10 | 328 |
if (! (inhclass.isPublic() || |
329 |
Util.isLinkable(inhclass, configuration))) { |
|
330 |
continue; |
|
331 |
} |
|
332 |
if (inhclass == classDoc) { |
|
333 |
continue; |
|
334 |
} |
|
868 | 335 |
List<ProgramElementDoc> inhmembers = visibleMemberMap.getMembersFor(inhclass); |
10 | 336 |
if (inhmembers.size() > 0) { |
337 |
Collections.sort(inhmembers); |
|
338 |
writer.writeInheritedMemberSummaryHeader(inhclass); |
|
339 |
for (int j = 0; j < inhmembers.size(); ++j) { |
|
340 |
writer.writeInheritedMemberSummary( |
|
341 |
inhclass.isPackagePrivate() && |
|
342 |
! Util.isLinkable(inhclass, configuration) ? |
|
343 |
classDoc : inhclass, |
|
868 | 344 |
inhmembers.get(j), |
10 | 345 |
j == 0, |
346 |
j == inhmembers.size() - 1); |
|
347 |
} |
|
348 |
writer.writeInheritedMemberSummaryFooter(inhclass); |
|
349 |
} |
|
350 |
} |
|
351 |
} |
|
352 |
} |