src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/MethodWriterImpl.java
Print this page
@@ -1,7 +1,7 @@
/*
- * Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
@@ -21,20 +21,35 @@
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
-package com.sun.tools.doclets.formats.html;
+package jdk.javadoc.internal.doclets.formats.html;
import java.io.*;
-import com.sun.javadoc.*;
-import com.sun.tools.doclets.formats.html.markup.*;
-import com.sun.tools.doclets.internal.toolkit.*;
-import com.sun.tools.doclets.internal.toolkit.util.*;
-import com.sun.tools.javac.util.StringUtils;
+import java.util.Arrays;
+import java.util.List;
+import java.util.SortedSet;
+import java.util.TreeSet;
+import javax.lang.model.element.Element;
+import javax.lang.model.element.ExecutableElement;
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.type.TypeMirror;
+
+import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
+import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
+import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
+import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
+import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
+import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
+import jdk.javadoc.internal.doclets.toolkit.MethodWriter;
+import jdk.javadoc.internal.doclets.toolkit.util.ImplementedMethods;
+import jdk.javadoc.internal.doclets.toolkit.util.Utils;
+
/**
* Writes method documentation in HTML format.
*
* <p><b>This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
@@ -51,14 +66,14 @@
/**
* Construct a new MethodWriterImpl.
*
* @param writer the writer for the class that the methods belong to.
- * @param classDoc the class being documented.
+ * @param typeElement the class being documented.
*/
- public MethodWriterImpl(SubWriterHolderWriter writer, ClassDoc classDoc) {
- super(writer, classDoc);
+ public MethodWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
+ super(writer, typeElement);
}
/**
* Construct a new MethodWriterImpl.
*
@@ -69,15 +84,15 @@
}
/**
* {@inheritDoc}
*/
- public Content getMemberSummaryHeader(ClassDoc classDoc,
- Content memberSummaryTree) {
+ @Override
+ public Content getMemberSummaryHeader(TypeElement typeElement, Content memberSummaryTree) {
memberSummaryTree.addContent(HtmlConstants.START_OF_METHOD_SUMMARY);
Content memberTree = writer.getMemberTreeHeader();
- writer.addSummaryHeader(this, classDoc, memberTree);
+ writer.addSummaryHeader(this, typeElement, memberTree);
return memberTree;
}
/**
* {@inheritDoc}
@@ -87,12 +102,12 @@
}
/**
* {@inheritDoc}
*/
- public Content getMethodDetailsTreeHeader(ClassDoc classDoc,
- Content memberDetailsTree) {
+ @Override
+ public Content getMethodDetailsTreeHeader(TypeElement typeElement, Content memberDetailsTree) {
memberDetailsTree.addContent(HtmlConstants.START_OF_METHOD_DETAILS);
Content methodDetailsTree = writer.getMemberTreeHeader();
methodDetailsTree.addContent(writer.getMarkerAnchor(
SectionName.METHOD_DETAIL));
Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
@@ -102,21 +117,21 @@
}
/**
* {@inheritDoc}
*/
- public Content getMethodDocTreeHeader(MethodDoc method,
- Content methodDetailsTree) {
+ @Override
+ public Content getMethodDocTreeHeader(ExecutableElement method, Content methodDetailsTree) {
String erasureAnchor;
if ((erasureAnchor = getErasureAnchor(method)) != null) {
methodDetailsTree.addContent(writer.getMarkerAnchor((erasureAnchor)));
}
methodDetailsTree.addContent(
writer.getMarkerAnchor(writer.getAnchor(method)));
Content methodDocTree = writer.getMemberTreeHeader();
Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
- heading.addContent(method.name());
+ heading.addContent(name(method));
methodDocTree.addContent(heading);
return methodDocTree;
}
/**
@@ -123,22 +138,23 @@
* Get the signature for the given method.
*
* @param method the method being documented.
* @return a content object for the signature
*/
- public Content getSignature(MethodDoc method) {
+ @Override
+ public Content getSignature(ExecutableElement method) {
Content pre = new HtmlTree(HtmlTag.PRE);
writer.addAnnotationInfo(method, pre);
int annotationLength = pre.charCount();
addModifiers(method, pre);
addTypeParameters(method, pre);
addReturnType(method, pre);
if (configuration.linksource) {
- Content methodName = new StringContent(method.name());
+ Content methodName = new StringContent(name(method));
writer.addSrcLink(method, methodName, pre);
} else {
- addName(method.name(), pre);
+ addName(name(method), pre);
}
int indent = pre.charCount() - annotationLength;
addParameters(method, pre, indent);
addExceptions(method, pre, indent);
return pre;
@@ -145,34 +161,39 @@
}
/**
* {@inheritDoc}
*/
- public void addDeprecated(MethodDoc method, Content methodDocTree) {
+ @Override
+ public void addDeprecated(ExecutableElement method, Content methodDocTree) {
addDeprecatedInfo(method, methodDocTree);
}
/**
* {@inheritDoc}
*/
- public void addComments(Type holder, MethodDoc method, Content methodDocTree) {
- ClassDoc holderClassDoc = holder.asClassDoc();
- if (method.inlineTags().length > 0) {
- if (holder.asClassDoc().equals(classdoc) ||
- (! (holderClassDoc.isPublic() ||
- utils.isLinkable(holderClassDoc, configuration)))) {
+ @Override
+ public void addComments(TypeMirror holderType, ExecutableElement method, Content methodDocTree) {
+ TypeElement holder = utils.asTypeElement(holderType);
+ if (!utils.getBody(method).isEmpty()) {
+ if (holder.equals(typeElement) ||
+ !(utils.isPublic(holder) ||
+ utils.isLinkable(holder))) {
writer.addInlineComment(method, methodDocTree);
} else {
Content link =
- writer.getDocLink(LinkInfoImpl.Kind.METHOD_DOC_COPY,
- holder.asClassDoc(), method,
- holder.asClassDoc().isIncluded() ?
- holder.typeName() : holder.qualifiedTypeName(),
+ writer.getDocLink(LinkInfoImpl.Kind.EXECUTABLE_ELEMENT_COPY,
+ holder, method,
+ utils.isIncluded(holder)
+ ? utils.getSimpleName(holder)
+ : utils.getFullyQualifiedName(holder),
false);
Content codelLink = HtmlTree.CODE(link);
- Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel, holder.asClassDoc().isClass()?
- writer.descfrmClassLabel : writer.descfrmInterfaceLabel);
+ Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel,
+ utils.isClass(holder)
+ ? writer.descfrmClassLabel
+ : writer.descfrmInterfaceLabel);
descfrmLabel.addContent(writer.getSpace());
descfrmLabel.addContent(codelLink);
methodDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
writer.addInlineComment(method, methodDocTree);
}
@@ -180,17 +201,19 @@
}
/**
* {@inheritDoc}
*/
- public void addTags(MethodDoc method, Content methodDocTree) {
+ @Override
+ public void addTags(ExecutableElement method, Content methodDocTree) {
writer.addTagsInfo(method, methodDocTree);
}
/**
* {@inheritDoc}
*/
+ @Override
public Content getMethodDetails(Content methodDetailsTree) {
if (configuration.allowTag(HtmlTag.SECTION)) {
HtmlTree htmlTree = HtmlTree.SECTION(getMemberTree(methodDetailsTree));
return htmlTree;
}
@@ -198,89 +221,92 @@
}
/**
* {@inheritDoc}
*/
+ @Override
public Content getMethodDoc(Content methodDocTree,
boolean isLastContent) {
return getMemberTree(methodDocTree, isLastContent);
}
/**
* Close the writer.
*/
+ @Override
public void close() throws IOException {
writer.close();
}
- public int getMemberKind() {
- return VisibleMemberMap.METHODS;
- }
-
/**
* {@inheritDoc}
*/
+ @Override
public void addSummaryLabel(Content memberTree) {
Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
writer.getResource("doclet.Method_Summary"));
memberTree.addContent(label);
}
/**
* {@inheritDoc}
*/
+ @Override
public String getTableSummary() {
return configuration.getText("doclet.Member_Table_Summary",
configuration.getText("doclet.Method_Summary"),
configuration.getText("doclet.methods"));
}
/**
* {@inheritDoc}
*/
+ @Override
public Content getCaption() {
return configuration.getResource("doclet.Methods");
}
/**
* {@inheritDoc}
*/
- public String[] getSummaryTableHeader(ProgramElementDoc member) {
- String[] header = new String[] {
- writer.getModifierTypeHeader(),
+ @Override
+ public List<String> getSummaryTableHeader(Element member) {
+ List<String> header = Arrays.asList(writer.getModifierTypeHeader(),
configuration.getText("doclet.0_and_1",
configuration.getText("doclet.Method"),
- configuration.getText("doclet.Description"))
- };
+ configuration.getText("doclet.Description")));
return header;
}
/**
* {@inheritDoc}
*/
- public void addSummaryAnchor(ClassDoc cd, Content memberTree) {
+ @Override
+ public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
memberTree.addContent(writer.getMarkerAnchor(
SectionName.METHOD_SUMMARY));
}
/**
* {@inheritDoc}
*/
- public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) {
+ @Override
+ public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
inheritedTree.addContent(writer.getMarkerAnchor(
- SectionName.METHODS_INHERITANCE, configuration.getClassName(cd)));
+ SectionName.METHODS_INHERITANCE, configuration.getClassName(typeElement)));
}
/**
* {@inheritDoc}
*/
- public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) {
+ @Override
+ public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
Content classLink = writer.getPreQualifiedClassLink(
- LinkInfoImpl.Kind.MEMBER, cd, false);
- Content label = new StringContent(cd.isClass() ?
- configuration.getText("doclet.Methods_Inherited_From_Class") :
- configuration.getText("doclet.Methods_Inherited_From_Interface"));
+ LinkInfoImpl.Kind.MEMBER, typeElement, false);
+ Content label = new StringContent(utils.isClass(typeElement)
+ ? configuration.getText("doclet.Methods_Inherited_From_Class")
+ : configuration.getText("doclet.Methods_Inherited_From_Interface"));
Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING,
label);
labelHeading.addContent(writer.getSpace());
labelHeading.addContent(classLink);
inheritedTree.addContent(labelHeading);
@@ -287,39 +313,41 @@
}
/**
* {@inheritDoc}
*/
- protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) {
- MethodDoc meth = (MethodDoc)member;
- addModifierAndType(meth, meth.returnType(), tdSummaryType);
+ @Override
+ protected void addSummaryType(Element member, Content tdSummaryType) {
+ ExecutableElement meth = (ExecutableElement)member;
+ addModifierAndType(meth, utils.getReturnType(meth), tdSummaryType);
}
/**
* {@inheritDoc}
*/
protected static void addOverridden(HtmlDocletWriter writer,
- Type overriddenType, MethodDoc method, Content dl) {
+ TypeMirror overriddenType, ExecutableElement method, Content dl) {
if (writer.configuration.nocomment) {
return;
}
- ClassDoc holderClassDoc = overriddenType.asClassDoc();
- if (! (holderClassDoc.isPublic() ||
- writer.configuration.utils.isLinkable(holderClassDoc, writer.configuration))) {
+ Utils utils = writer.configuration().utils;
+ TypeElement holder = utils.getEnclosingTypeElement(method);
+ if (!(utils.isPublic(holder) ||
+ utils.isLinkable(holder))) {
//This is an implementation detail that should not be documented.
return;
}
- if (overriddenType.asClassDoc().isIncluded() && ! method.isIncluded()) {
+ if (utils.isIncluded(holder) && ! utils.isIncluded(method)) {
//The class is included but the method is not. That means that it
//is not visible so don't document this.
return;
}
Content label = writer.overridesLabel;
LinkInfoImpl.Kind context = LinkInfoImpl.Kind.METHOD_OVERRIDES;
if (method != null) {
- if (overriddenType.asClassDoc().isAbstract() && method.isAbstract()){
+ if (utils.isAbstract(holder) && utils.isAbstract(method)){
//Abstract method is implemented from abstract class,
//not overridden
label = writer.specifiedByLabel;
context = LinkInfoImpl.Kind.METHOD_SPECIFIED_BY;
}
@@ -326,14 +354,14 @@
Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, label));
dl.addContent(dt);
Content overriddenTypeLink =
writer.getLink(new LinkInfoImpl(writer.configuration, context, overriddenType));
Content codeOverridenTypeLink = HtmlTree.CODE(overriddenTypeLink);
- String name = method.name();
+ String name = method.getSimpleName().toString();
Content methlink = writer.getLink(
new LinkInfoImpl(writer.configuration, LinkInfoImpl.Kind.MEMBER,
- overriddenType.asClassDoc())
+ holder)
.where(writer.getName(writer.getAnchor(method))).label(name));
Content codeMethLink = HtmlTree.CODE(methlink);
Content dd = HtmlTree.DD(codeMethLink);
dd.addContent(writer.getSpace());
dd.addContent(writer.getResource("doclet.in_class"));
@@ -345,27 +373,31 @@
/**
* {@inheritDoc}
*/
protected static void addImplementsInfo(HtmlDocletWriter writer,
- MethodDoc method, Content dl) {
- if(writer.configuration.nocomment){
+ ExecutableElement method, Content dl) {
+ if (writer.configuration.nocomment) {
return;
}
+ Utils utils = writer.utils;
ImplementedMethods implementedMethodsFinder =
new ImplementedMethods(method, writer.configuration);
- MethodDoc[] implementedMethods = implementedMethodsFinder.build();
- for (MethodDoc implementedMeth : implementedMethods) {
- Type intfac = implementedMethodsFinder.getMethodHolder(implementedMeth);
+ SortedSet<ExecutableElement> implementedMethods =
+ new TreeSet<>(utils.makeOverrideUseComparator());
+ implementedMethods.addAll(implementedMethodsFinder.build());
+ for (ExecutableElement implementedMeth : implementedMethods) {
+ TypeMirror intfac = implementedMethodsFinder.getMethodHolder(implementedMeth);
+ intfac = utils.getDeclaredType(utils.getEnclosingTypeElement(method), intfac);
Content intfaclink = writer.getLink(new LinkInfoImpl(
writer.configuration, LinkInfoImpl.Kind.METHOD_SPECIFIED_BY, intfac));
Content codeIntfacLink = HtmlTree.CODE(intfaclink);
Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, writer.specifiedByLabel));
dl.addContent(dt);
Content methlink = writer.getDocLink(
LinkInfoImpl.Kind.MEMBER, implementedMeth,
- implementedMeth.name(), false);
+ implementedMeth.getSimpleName().toString(), false);
Content codeMethLink = HtmlTree.CODE(methlink);
Content dd = HtmlTree.DD(codeMethLink);
dd.addContent(writer.getSpace());
dd.addContent(writer.getResource("doclet.in_interface"));
dd.addContent(writer.getSpace());
@@ -378,12 +410,12 @@
* Add the return type.
*
* @param method the method being documented.
* @param htmltree the content tree to which the return type will be added
*/
- protected void addReturnType(MethodDoc method, Content htmltree) {
- Type type = method.returnType();
+ protected void addReturnType(ExecutableElement method, Content htmltree) {
+ TypeMirror type = utils.getReturnType(method);
if (type != null) {
Content linkContent = writer.getLink(
new LinkInfoImpl(configuration, LinkInfoImpl.Kind.RETURN_TYPE, type));
htmltree.addContent(linkContent);
htmltree.addContent(writer.getSpace());
@@ -391,29 +423,31 @@
}
/**
* {@inheritDoc}
*/
- protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
+ @Override
+ protected Content getNavSummaryLink(TypeElement typeElement, boolean link) {
if (link) {
- if (cd == null) {
+ if (typeElement == null) {
return writer.getHyperLink(
SectionName.METHOD_SUMMARY,
writer.getResource("doclet.navMethod"));
} else {
return writer.getHyperLink(
SectionName.METHODS_INHERITANCE,
- configuration.getClassName(cd), writer.getResource("doclet.navMethod"));
+ configuration.getClassName(typeElement), writer.getResource("doclet.navMethod"));
}
} else {
return writer.getResource("doclet.navMethod");
}
}
/**
* {@inheritDoc}
*/
+ @Override
protected void addNavDetailLink(boolean link, Content liNav) {
if (link) {
liNav.addContent(writer.getHyperLink(
SectionName.METHOD_DETAIL, writer.getResource("doclet.navMethod")));
} else {