1 /*
2 * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
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
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
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 *
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.
24 */
25
26 package jdk.javadoc.internal.doclets.formats.html;
27
28 import java.util.Arrays;
29 import java.util.List;
30 import java.util.SortedSet;
31 import java.util.TreeSet;
32
33 import javax.lang.model.element.Element;
34 import javax.lang.model.element.ExecutableElement;
35 import javax.lang.model.element.TypeElement;
36 import javax.lang.model.type.TypeMirror;
37
38 import jdk.javadoc.internal.doclets.formats.html.TableHeader;
39 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
40 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
41 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
42 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
43 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
44 import jdk.javadoc.internal.doclets.toolkit.Content;
45 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
46 import jdk.javadoc.internal.doclets.toolkit.MethodWriter;
47 import jdk.javadoc.internal.doclets.toolkit.util.ImplementedMethods;
48 import jdk.javadoc.internal.doclets.toolkit.util.Utils;
49
50 /**
51 * Writes method documentation in HTML format.
52 *
53 * <p><b>This is NOT part of any supported API.
54 * If you write code that depends on this, you do so at your own risk.
55 * This code and its internal interfaces are subject to change or
56 * deletion without notice.</b>
57 *
58 * @author Robert Field
59 * @author Atul M Dambalkar
60 * @author Jamie Ho (rewrite)
61 * @author Bhavesh Patel (Modified)
62 */
63 public class MethodWriterImpl extends AbstractExecutableMemberWriter
64 implements MethodWriter, MemberSummaryWriter {
65
66 /**
67 * Construct a new MethodWriterImpl.
68 *
69 * @param writer the writer for the class that the methods belong to.
70 * @param typeElement the class being documented.
71 */
72 public MethodWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
73 super(writer, typeElement);
74 }
75
76 /**
77 * Construct a new MethodWriterImpl.
78 *
79 * @param writer The writer for the class that the methods belong to.
80 */
81 public MethodWriterImpl(SubWriterHolderWriter writer) {
82 super(writer);
83 }
84
85 /**
86 * {@inheritDoc}
87 */
88 @Override
89 public Content getMemberSummaryHeader(TypeElement typeElement, Content memberSummaryTree) {
90 memberSummaryTree.addContent(HtmlConstants.START_OF_METHOD_SUMMARY);
91 Content memberTree = writer.getMemberTreeHeader();
92 writer.addSummaryHeader(this, typeElement, memberTree);
93 return memberTree;
94 }
95
96 /**
97 * {@inheritDoc}
98 */
99 public void addMemberTree(Content memberSummaryTree, Content memberTree) {
100 writer.addMemberTree(memberSummaryTree, memberTree);
101 }
102
103 /**
104 * {@inheritDoc}
105 */
106 @Override
107 public Content getMethodDetailsTreeHeader(TypeElement typeElement, Content memberDetailsTree) {
108 memberDetailsTree.addContent(HtmlConstants.START_OF_METHOD_DETAILS);
109 Content methodDetailsTree = writer.getMemberTreeHeader();
110 methodDetailsTree.addContent(writer.getMarkerAnchor(
111 SectionName.METHOD_DETAIL));
112 Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
113 contents.methodDetailLabel);
114 methodDetailsTree.addContent(heading);
115 return methodDetailsTree;
116 }
117
118 /**
119 * {@inheritDoc}
120 */
121 @Override
122 public Content getMethodDocTreeHeader(ExecutableElement method, Content methodDetailsTree) {
123 String erasureAnchor;
124 if ((erasureAnchor = getErasureAnchor(method)) != null) {
125 methodDetailsTree.addContent(writer.getMarkerAnchor((erasureAnchor)));
126 }
127 methodDetailsTree.addContent(
128 writer.getMarkerAnchor(writer.getAnchor(method)));
129 Content methodDocTree = writer.getMemberTreeHeader();
130 Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
131 heading.addContent(name(method));
132 methodDocTree.addContent(heading);
133 return methodDocTree;
134 }
135
136 /**
137 * Get the signature for the given method.
138 *
139 * @param method the method being documented.
140 * @return a content object for the signature
141 */
142 @Override
143 public Content getSignature(ExecutableElement method) {
144 Content pre = new HtmlTree(HtmlTag.PRE);
145 writer.addAnnotationInfo(method, pre);
146 int annotationLength = pre.charCount();
147 addModifiers(method, pre);
148 addTypeParameters(method, pre);
149 addReturnType(method, pre);
150 if (configuration.linksource) {
151 Content methodName = new StringContent(name(method));
152 writer.addSrcLink(method, methodName, pre);
153 } else {
154 addName(name(method), pre);
155 }
156 int indent = pre.charCount() - annotationLength;
157 addParameters(method, pre, indent);
158 addExceptions(method, pre, indent);
159 return pre;
160 }
161
162 /**
163 * {@inheritDoc}
164 */
165 @Override
166 public void addDeprecated(ExecutableElement method, Content methodDocTree) {
167 addDeprecatedInfo(method, methodDocTree);
168 }
169
170 /**
171 * {@inheritDoc}
172 */
173 @Override
174 public void addComments(TypeMirror holderType, ExecutableElement method, Content methodDocTree) {
175 TypeElement holder = utils.asTypeElement(holderType);
176 if (!utils.getFullBody(method).isEmpty()) {
177 if (holder.equals(typeElement) ||
178 !(utils.isPublic(holder) ||
179 utils.isLinkable(holder))) {
180 writer.addInlineComment(method, methodDocTree);
181 } else {
182 Content link =
183 writer.getDocLink(LinkInfoImpl.Kind.EXECUTABLE_ELEMENT_COPY,
184 holder, method,
185 utils.isIncluded(holder)
186 ? utils.getSimpleName(holder)
187 : utils.getFullyQualifiedName(holder),
188 false);
189 Content codelLink = HtmlTree.CODE(link);
190 Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel,
191 utils.isClass(holder)
192 ? contents.descfrmClassLabel
193 : contents.descfrmInterfaceLabel);
194 descfrmLabel.addContent(Contents.SPACE);
195 descfrmLabel.addContent(codelLink);
196 methodDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
197 writer.addInlineComment(method, methodDocTree);
198 }
199 }
200 }
201
202 /**
203 * {@inheritDoc}
204 */
205 @Override
206 public void addTags(ExecutableElement method, Content methodDocTree) {
207 writer.addTagsInfo(method, methodDocTree);
208 }
209
210 /**
211 * {@inheritDoc}
212 */
213 @Override
214 public Content getMethodDetails(Content methodDetailsTree) {
215 if (configuration.allowTag(HtmlTag.SECTION)) {
216 HtmlTree htmlTree = HtmlTree.SECTION(getMemberTree(methodDetailsTree));
217 return htmlTree;
218 }
219 return getMemberTree(methodDetailsTree);
220 }
221
222 /**
223 * {@inheritDoc}
224 */
225 @Override
226 public Content getMethodDoc(Content methodDocTree,
227 boolean isLastContent) {
228 return getMemberTree(methodDocTree, isLastContent);
229 }
230
231 /**
232 * {@inheritDoc}
233 */
234 @Override
235 public void addSummaryLabel(Content memberTree) {
236 Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
237 contents.methodSummary);
238 memberTree.addContent(label);
239 }
240
241 /**
242 * {@inheritDoc}
243 */
244 @Override
245 public String getTableSummary() {
246 return resources.getText("doclet.Member_Table_Summary",
247 resources.getText("doclet.Method_Summary"),
248 resources.getText("doclet.methods"));
249 }
250
251 /**
252 * {@inheritDoc}
253 */
254 @Override
255 public Content getCaption() {
256 return contents.methods;
257 }
258
259 /**
260 * {@inheritDoc}
261 */
262 @Override
263 public TableHeader getSummaryTableHeader(Element member) {
264 return new TableHeader(contents.modifierAndTypeLabel, contents.methodLabel,
265 contents.descriptionLabel);
266 }
267
268 /**
269 * {@inheritDoc}
270 */
271 @Override
272 public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
273 memberTree.addContent(writer.getMarkerAnchor(
274 SectionName.METHOD_SUMMARY));
275 }
276
277 /**
278 * {@inheritDoc}
279 */
280 @Override
281 public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
282 inheritedTree.addContent(writer.getMarkerAnchor(
283 SectionName.METHODS_INHERITANCE, configuration.getClassName(typeElement)));
284 }
285
286 /**
287 * {@inheritDoc}
288 */
289 @Override
290 public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
291 Content classLink = writer.getPreQualifiedClassLink(
292 LinkInfoImpl.Kind.MEMBER, typeElement, false);
293 Content label = new StringContent(utils.isClass(typeElement)
294 ? configuration.getText("doclet.Methods_Inherited_From_Class")
295 : configuration.getText("doclet.Methods_Inherited_From_Interface"));
296 Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING,
297 label);
298 labelHeading.addContent(Contents.SPACE);
299 labelHeading.addContent(classLink);
300 inheritedTree.addContent(labelHeading);
301 }
302
303 /**
304 * {@inheritDoc}
305 */
306 @Override
307 protected void addSummaryType(Element member, Content tdSummaryType) {
308 ExecutableElement meth = (ExecutableElement)member;
309 addModifierAndType(meth, utils.getReturnType(meth), tdSummaryType);
310 }
311
312 /**
313 * {@inheritDoc}
314 */
315 protected static void addOverridden(HtmlDocletWriter writer,
316 TypeMirror overriddenType, ExecutableElement method, Content dl) {
317 if (writer.configuration.nocomment) {
318 return;
319 }
320 Utils utils = writer.utils;
321 Contents contents = writer.contents;
322 TypeElement holder = utils.getEnclosingTypeElement(method);
323 if (!(utils.isPublic(holder) ||
324 utils.isLinkable(holder))) {
325 //This is an implementation detail that should not be documented.
326 return;
327 }
328 if (utils.isIncluded(holder) && ! utils.isIncluded(method)) {
329 //The class is included but the method is not. That means that it
330 //is not visible so don't document this.
331 return;
332 }
333 Content label = contents.overridesLabel;
334 LinkInfoImpl.Kind context = LinkInfoImpl.Kind.METHOD_OVERRIDES;
335
336 if (method != null) {
337 if (utils.isAbstract(holder) && utils.isAbstract(method)){
338 //Abstract method is implemented from abstract class,
339 //not overridden
340 label = contents.specifiedByLabel;
341 context = LinkInfoImpl.Kind.METHOD_SPECIFIED_BY;
342 }
343 Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, label));
344 dl.addContent(dt);
345 Content overriddenTypeLink =
346 writer.getLink(new LinkInfoImpl(writer.configuration, context, overriddenType));
347 Content codeOverridenTypeLink = HtmlTree.CODE(overriddenTypeLink);
348 Content methlink = writer.getLink(
349 new LinkInfoImpl(writer.configuration, LinkInfoImpl.Kind.MEMBER,
350 holder)
351 .where(writer.getName(writer.getAnchor(method))).label(method.getSimpleName()));
352 Content codeMethLink = HtmlTree.CODE(methlink);
353 Content dd = HtmlTree.DD(codeMethLink);
354 dd.addContent(Contents.SPACE);
355 dd.addContent(writer.contents.inClass);
356 dd.addContent(Contents.SPACE);
357 dd.addContent(codeOverridenTypeLink);
358 dl.addContent(dd);
359 }
360 }
361
362 /**
363 * {@inheritDoc}
364 */
365 protected static void addImplementsInfo(HtmlDocletWriter writer,
366 ExecutableElement method, Content dl) {
367 Utils utils = writer.utils;
368 if (utils.isStatic(method) || writer.configuration.nocomment) {
369 return;
370 }
371 Contents contents = writer.contents;
372 ImplementedMethods implementedMethodsFinder =
373 new ImplementedMethods(method, writer.configuration);
374 SortedSet<ExecutableElement> implementedMethods =
375 new TreeSet<>(utils.makeOverrideUseComparator());
376 implementedMethods.addAll(implementedMethodsFinder.build());
377 for (ExecutableElement implementedMeth : implementedMethods) {
378 TypeMirror intfac = implementedMethodsFinder.getMethodHolder(implementedMeth);
379 intfac = utils.getDeclaredType(utils.getEnclosingTypeElement(method), intfac);
380 Content intfaclink = writer.getLink(new LinkInfoImpl(
381 writer.configuration, LinkInfoImpl.Kind.METHOD_SPECIFIED_BY, intfac));
382 Content codeIntfacLink = HtmlTree.CODE(intfaclink);
383 Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, contents.specifiedByLabel));
384 dl.addContent(dt);
385 Content methlink = writer.getDocLink(
386 LinkInfoImpl.Kind.MEMBER, implementedMeth,
387 implementedMeth.getSimpleName(), false);
388 Content codeMethLink = HtmlTree.CODE(methlink);
389 Content dd = HtmlTree.DD(codeMethLink);
390 dd.addContent(Contents.SPACE);
391 dd.addContent(contents.inInterface);
392 dd.addContent(Contents.SPACE);
393 dd.addContent(codeIntfacLink);
394 dl.addContent(dd);
395 }
396 }
397
398 /**
399 * Add the return type.
400 *
401 * @param method the method being documented.
402 * @param htmltree the content tree to which the return type will be added
403 */
404 protected void addReturnType(ExecutableElement method, Content htmltree) {
405 TypeMirror type = utils.getReturnType(method);
406 if (type != null) {
407 Content linkContent = writer.getLink(
408 new LinkInfoImpl(configuration, LinkInfoImpl.Kind.RETURN_TYPE, type));
409 htmltree.addContent(linkContent);
410 htmltree.addContent(Contents.SPACE);
411 }
412 }
413
414 /**
415 * {@inheritDoc}
416 */
417 @Override
418 protected Content getNavSummaryLink(TypeElement typeElement, boolean link) {
419 if (link) {
420 if (typeElement == null) {
421 return writer.getHyperLink(
422 SectionName.METHOD_SUMMARY,
423 contents.navMethod);
424 } else {
425 return writer.getHyperLink(
426 SectionName.METHODS_INHERITANCE,
427 configuration.getClassName(typeElement), contents.navMethod);
428 }
429 } else {
430 return contents.navMethod;
431 }
432 }
433
434 /**
435 * {@inheritDoc}
436 */
437 @Override
438 protected void addNavDetailLink(boolean link, Content liNav) {
439 if (link) {
440 liNav.addContent(writer.getHyperLink(
441 SectionName.METHOD_DETAIL, contents.navMethod));
442 } else {
443 liNav.addContent(contents.navMethod);
444 }
445 }
446 }