MethodWriterImpl.java revision 3692:87b48a8fb3cf 
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
26package jdk.javadoc.internal.doclets.formats.html;
27
28import java.util.Arrays;
29import java.util.List;
30import java.util.SortedSet;
31import java.util.TreeSet;
32
33import javax.lang.model.element.Element;
34import javax.lang.model.element.ExecutableElement;
35import javax.lang.model.element.TypeElement;
36import javax.lang.model.type.TypeMirror;
37
38import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
39import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
40import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
41import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
42import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
43import jdk.javadoc.internal.doclets.toolkit.Content;
44import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
45import jdk.javadoc.internal.doclets.toolkit.MethodWriter;
46import jdk.javadoc.internal.doclets.toolkit.util.ImplementedMethods;
47import jdk.javadoc.internal.doclets.toolkit.util.Utils;
48
49/**
50 * Writes method documentation in HTML format.
51 *
52 *  <p><b>This is NOT part of any supported API.
53 *  If you write code that depends on this, you do so at your own risk.
54 *  This code and its internal interfaces are subject to change or
55 *  deletion without notice.</b>
56 *
57 * @author Robert Field
58 * @author Atul M Dambalkar
59 * @author Jamie Ho (rewrite)
60 * @author Bhavesh Patel (Modified)
61 */
62public class MethodWriterImpl extends AbstractExecutableMemberWriter
63        implements MethodWriter, MemberSummaryWriter {
64
65    /**
66     * Construct a new MethodWriterImpl.
67     *
68     * @param writer the writer for the class that the methods belong to.
69     * @param typeElement the class being documented.
70     */
71    public MethodWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
72        super(writer, typeElement);
73    }
74
75    /**
76     * Construct a new MethodWriterImpl.
77     *
78     * @param writer The writer for the class that the methods belong to.
79     */
80    public MethodWriterImpl(SubWriterHolderWriter writer) {
81        super(writer);
82    }
83
84    /**
85     * {@inheritDoc}
86     */
87    @Override
88    public Content getMemberSummaryHeader(TypeElement typeElement, Content memberSummaryTree) {
89        memberSummaryTree.addContent(HtmlConstants.START_OF_METHOD_SUMMARY);
90        Content memberTree = writer.getMemberTreeHeader();
91        writer.addSummaryHeader(this, typeElement, memberTree);
92        return memberTree;
93    }
94
95    /**
96     * {@inheritDoc}
97     */
98    public void addMemberTree(Content memberSummaryTree, Content memberTree) {
99        writer.addMemberTree(memberSummaryTree, memberTree);
100    }
101
102    /**
103     * {@inheritDoc}
104     */
105    @Override
106    public Content getMethodDetailsTreeHeader(TypeElement typeElement, Content memberDetailsTree) {
107        memberDetailsTree.addContent(HtmlConstants.START_OF_METHOD_DETAILS);
108        Content methodDetailsTree = writer.getMemberTreeHeader();
109        methodDetailsTree.addContent(writer.getMarkerAnchor(
110                SectionName.METHOD_DETAIL));
111        Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
112                contents.methodDetailLabel);
113        methodDetailsTree.addContent(heading);
114        return methodDetailsTree;
115    }
116
117    /**
118     * {@inheritDoc}
119     */
120    @Override
121    public Content getMethodDocTreeHeader(ExecutableElement method, Content methodDetailsTree) {
122        String erasureAnchor;
123        if ((erasureAnchor = getErasureAnchor(method)) != null) {
124            methodDetailsTree.addContent(writer.getMarkerAnchor((erasureAnchor)));
125        }
126        methodDetailsTree.addContent(
127                writer.getMarkerAnchor(writer.getAnchor(method)));
128        Content methodDocTree = writer.getMemberTreeHeader();
129        Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
130        heading.addContent(name(method));
131        methodDocTree.addContent(heading);
132        return methodDocTree;
133    }
134
135    /**
136     * Get the signature for the given method.
137     *
138     * @param method the method being documented.
139     * @return a content object for the signature
140     */
141    @Override
142    public Content getSignature(ExecutableElement method) {
143        Content pre = new HtmlTree(HtmlTag.PRE);
144        writer.addAnnotationInfo(method, pre);
145        int annotationLength = pre.charCount();
146        addModifiers(method, pre);
147        addTypeParameters(method, pre);
148        addReturnType(method, pre);
149        if (configuration.linksource) {
150            Content methodName = new StringContent(name(method));
151            writer.addSrcLink(method, methodName, pre);
152        } else {
153            addName(name(method), pre);
154        }
155        int indent = pre.charCount() - annotationLength;
156        addParameters(method, pre, indent);
157        addExceptions(method, pre, indent);
158        return pre;
159    }
160
161    /**
162     * {@inheritDoc}
163     */
164    @Override
165    public void addDeprecated(ExecutableElement method, Content methodDocTree) {
166        addDeprecatedInfo(method, methodDocTree);
167    }
168
169    /**
170     * {@inheritDoc}
171     */
172    @Override
173    public void addComments(TypeMirror holderType, ExecutableElement method, Content methodDocTree) {
174        TypeElement holder = utils.asTypeElement(holderType);
175        if (!utils.getFullBody(method).isEmpty()) {
176            if (holder.equals(typeElement) ||
177                    !(utils.isPublic(holder) ||
178                    utils.isLinkable(holder))) {
179                writer.addInlineComment(method, methodDocTree);
180            } else {
181                Content link =
182                        writer.getDocLink(LinkInfoImpl.Kind.EXECUTABLE_ELEMENT_COPY,
183                        holder, method,
184                        utils.isIncluded(holder)
185                                ? utils.getSimpleName(holder)
186                                : utils.getFullyQualifiedName(holder),
187                            false);
188                Content codelLink = HtmlTree.CODE(link);
189                Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel,
190                        utils.isClass(holder)
191                                ? contents.descfrmClassLabel
192                                : contents.descfrmInterfaceLabel);
193                descfrmLabel.addContent(Contents.SPACE);
194                descfrmLabel.addContent(codelLink);
195                methodDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
196                writer.addInlineComment(method, methodDocTree);
197            }
198        }
199    }
200
201    /**
202     * {@inheritDoc}
203     */
204    @Override
205    public void addTags(ExecutableElement method, Content methodDocTree) {
206        writer.addTagsInfo(method, methodDocTree);
207    }
208
209    /**
210     * {@inheritDoc}
211     */
212    @Override
213    public Content getMethodDetails(Content methodDetailsTree) {
214        if (configuration.allowTag(HtmlTag.SECTION)) {
215            HtmlTree htmlTree = HtmlTree.SECTION(getMemberTree(methodDetailsTree));
216            return htmlTree;
217        }
218        return getMemberTree(methodDetailsTree);
219    }
220
221    /**
222     * {@inheritDoc}
223     */
224    @Override
225    public Content getMethodDoc(Content methodDocTree,
226            boolean isLastContent) {
227        return getMemberTree(methodDocTree, isLastContent);
228    }
229
230    /**
231     * {@inheritDoc}
232     */
233    @Override
234    public void addSummaryLabel(Content memberTree) {
235        Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
236                contents.methodSummary);
237        memberTree.addContent(label);
238    }
239
240    /**
241     * {@inheritDoc}
242     */
243    @Override
244    public String getTableSummary() {
245        return resources.getText("doclet.Member_Table_Summary",
246                resources.getText("doclet.Method_Summary"),
247                resources.getText("doclet.methods"));
248    }
249
250    /**
251     * {@inheritDoc}
252     */
253    @Override
254    public Content getCaption() {
255        return contents.methods;
256    }
257
258    /**
259     * {@inheritDoc}
260     */
261    @Override
262    public List<String> getSummaryTableHeader(Element member) {
263        List<String> header = Arrays.asList(writer.getModifierTypeHeader(),
264                resources.getText("doclet.Method"), resources.getText("doclet.Description"));
265        return header;
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        if (writer.configuration.nocomment) {
368            return;
369        }
370        Utils utils = writer.utils;
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}
447