jdk8-mips64-public/langtools: comparison src/share/classes/com/sun/tools/doclets/formats/html/MethodWriterImpl.java

-:bcbc86cc5b31
+:90af8d87741f
 package com.sun.tools.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.doclets.internal.toolkit.taglets.*;
 /**
 * Writes method documentation in HTML format.
 *
 * @author Robert Field
 * @author Bhavesh Patel (Modified)
 */
 public class MethodWriterImpl extends AbstractExecutableMemberWriter
 implements MethodWriter, MemberSummaryWriter {
-private boolean printedSummaryHeader = false;
 /**
 * Construct a new MethodWriterImpl.
 *
 * @param writer the writer for the class that the methods belong to.
 * @param classDoc the class being documented.
 public MethodWriterImpl(SubWriterHolderWriter writer) {
 super(writer);
 }
 /**
-* Write the methods summary header for the given class.
+* {@inheritDoc}
-*
+*/
-* @param classDoc the class the summary belongs to.
+public Content getMemberSummaryHeader(ClassDoc classDoc,
-*/
+Content memberSummaryTree) {
-public void writeMemberSummaryHeader(ClassDoc classDoc) {
+memberSummaryTree.addContent(HtmlConstants.START_OF_METHOD_SUMMARY);
-printedSummaryHeader = true;
+Content memberTree = writer.getMemberTreeHeader();
-writer.println();
+writer.addSummaryHeader(this, classDoc, memberTree);
-writer.println("<!-- ========== METHOD SUMMARY =========== -->");
+return memberTree;
-writer.println();
+}
-writer.printSummaryHeader(this, classDoc);
-}
+/**
+* {@inheritDoc}
-/**
+*/
-* Write the methods summary footer for the given class.
+public Content getMethodDetailsTreeHeader(ClassDoc classDoc,
-*
+Content memberDetailsTree) {
-* @param classDoc the class the summary belongs to.
+memberDetailsTree.addContent(HtmlConstants.START_OF_METHOD_DETAILS);
-*/
+Content methodDetailsTree = writer.getMemberTreeHeader();
-public void writeMemberSummaryFooter(ClassDoc classDoc) {
+methodDetailsTree.addContent(writer.getMarkerAnchor("method_detail"));
-writer.printSummaryFooter(this, classDoc);
+Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
-}
+writer.methodDetailsLabel);
+methodDetailsTree.addContent(heading);
-/**
+return methodDetailsTree;
-* Write the inherited methods summary header for the given class.
+}
-*
-* @param classDoc the class the summary belongs to.
+/**
-*/
+* {@inheritDoc}
-public void writeInheritedMemberSummaryHeader(ClassDoc classDoc) {
+*/
-if(! printedSummaryHeader){
+public Content getMethodDocTreeHeader(MethodDoc method,
-//We don't want inherited summary to not be under heading.
+Content methodDetailsTree) {
-writeMemberSummaryHeader(classDoc);
+String erasureAnchor;
-writeMemberSummaryFooter(classDoc);
+if ((erasureAnchor = getErasureAnchor(method)) != null) {
-printedSummaryHeader = true;
+methodDetailsTree.addContent(writer.getMarkerAnchor((erasureAnchor)));
 }
-writer.printInheritedSummaryHeader(this, classDoc);
+methodDetailsTree.addContent(
-}
+writer.getMarkerAnchor(writer.getAnchor(method)));
+Content methodDocTree = writer.getMemberTreeHeader();
-/**
+Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
-* {@inheritDoc}
+heading.addContent(method.name());
-*/
+methodDocTree.addContent(heading);
-public void writeInheritedMemberSummary(ClassDoc classDoc,
+return methodDocTree;
-ProgramElementDoc method, boolean isFirst, boolean isLast) {
+}
-writer.printInheritedSummaryMember(this, classDoc, method, isFirst);
-}
+/**
+* Get the signature for the given method.
-/**
-* Write the inherited methods summary footer for the given class.
-*
-* @param classDoc the class the summary belongs to.
-*/
-public void writeInheritedMemberSummaryFooter(ClassDoc classDoc) {
-writer.printInheritedSummaryFooter(this, classDoc);        ;
-}
-/**
-* Write the header for the method documentation.
-*
-* @param classDoc the class that the methods belong to.
-*/
-public void writeHeader(ClassDoc classDoc, String header) {
-writer.println();
-writer.println("<!-- ============ METHOD DETAIL ========== -->");
-writer.println();
-writer.anchor("method_detail");
-writer.printTableHeadingBackground(header);
-}
-/**
-* Write the method header for the given method.
 *
 * @param method the method being documented.
-* @param isFirst the flag to indicate whether or not the method is the
+* @return a content object for the signature
-*        first to be documented.
+*/
-*/
+public Content getSignature(MethodDoc method) {
-public void writeMethodHeader(MethodDoc method, boolean isFirst) {
-if (! isFirst) {
-writer.printMemberHeader();
-}
-writer.println();
-String erasureAnchor;
-if ((erasureAnchor = getErasureAnchor(method)) != null) {
-writer.anchor(erasureAnchor);
-}
-writer.anchor(method);
-writer.h3();
-writer.print(method.name());
-writer.h3End();
-}
-/**
-* Write the signature for the given method.
-*
-* @param method the method being documented.
-*/
-public void writeSignature(MethodDoc method) {
 writer.displayLength = 0;
-writer.pre();
+Content pre = new HtmlTree(HtmlTag.PRE);
-writer.writeAnnotationInfo(method);
+writer.addAnnotationInfo(method, pre);
-printModifiers(method);
+addModifiers(method, pre);
-writeTypeParameters(method);
+addTypeParameters(method, pre);
-printReturnType(method);
+addReturnType(method, pre);
 if (configuration().linksource) {
-writer.printSrcLink(method, method.name());
+Content methodName = new StringContent(method.name());
+writer.addSrcLink(method, methodName, pre);
 } else {
-strong(method.name());
+addName(method.name(), pre);
 }
-writeParameters(method);
+addParameters(method, pre);
-writeExceptions(method);
+addExceptions(method, pre);
-writer.preEnd();
+return pre;
-assert !writer.getMemberDetailsListPrinted();
+}
-}
+/**
-/**
+* {@inheritDoc}
-* Write the deprecated output for the given method.
+*/
-*
+public void addDeprecated(MethodDoc method, Content methodDocTree) {
-* @param method the method being documented.
+addDeprecatedInfo(method, methodDocTree);
-*/
+}
-public void writeDeprecated(MethodDoc method) {
-printDeprecated(method);
+/**
-}
+* {@inheritDoc}
+*/
-/**
+public void addComments(Type holder, MethodDoc method, Content methodDocTree) {
-* Write the comments for the given method.
-*
-* @param method the method being documented.
-*/
-public void writeComments(Type holder, MethodDoc method) {
 ClassDoc holderClassDoc = holder.asClassDoc();
 if (method.inlineTags().length > 0) {
-writer.printMemberDetailsListStartTag();
 if (holder.asClassDoc().equals(classdoc) ||
 (! (holderClassDoc.isPublic() ||
 Util.isLinkable(holderClassDoc, configuration())))) {
-writer.dd();
+writer.addInlineComment(method, methodDocTree);
-writer.printInlineComment(method);
-writer.ddEnd();
 } else {
-String classlink = writer.codeText(
+Content link = new RawHtml(
 writer.getDocLink(LinkInfoImpl.CONTEXT_METHOD_DOC_COPY,
 holder.asClassDoc(), method,
 holder.asClassDoc().isIncluded() ?
 holder.typeName() : holder.qualifiedTypeName(),
 false));
-writer.dd();
+Content codelLink = HtmlTree.CODE(link);
-writer.strongText(holder.asClassDoc().isClass()?
+Content strong = HtmlTree.STRONG(holder.asClassDoc().isClass()?
-"doclet.Description_From_Class":
+writer.descfrmClassLabel : writer.descfrmInterfaceLabel);
-"doclet.Description_From_Interface",
+strong.addContent(writer.getSpace());
-classlink);
+strong.addContent(codelLink);
-writer.ddEnd();
+methodDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, strong));
-writer.dd();
+writer.addInlineComment(method, methodDocTree);
-writer.printInlineComment(method);
-writer.ddEnd();
 }
 }
 }
 /**
-* Write the tag output for the given method.
+* {@inheritDoc}
-*
+*/
-* @param method the method being documented.
+public void addTags(MethodDoc method, Content methodDocTree) {
-*/
+writer.addTagsInfo(method, methodDocTree);
-public void writeTags(MethodDoc method) {
+}
-writer.printTags(method);
-}
+/**
+* {@inheritDoc}
-/**
+*/
-* Write the method footer.
+public Content getMethodDetails(Content methodDetailsTree) {
-*/
+return getMemberTree(methodDetailsTree);
-public void writeMethodFooter() {
+}
-printMemberFooter();
-}
+/**
+* {@inheritDoc}
-/**
+*/
-* Write the footer for the method documentation.
+public Content getMethodDoc(Content methodDocTree,
-*
+boolean isLastContent) {
-* @param classDoc the class that the methods belong to.
+return getMemberTree(methodDocTree, isLastContent);
-*/
-public void writeFooter(ClassDoc classDoc) {
-//No footer to write for method documentation
 }
 /**
 * Close the writer.
 */
 public int getMemberKind() {
 return VisibleMemberMap.METHODS;
 }
-public void printSummaryLabel() {
+/**
-writer.printText("doclet.Method_Summary");
+* {@inheritDoc}
-}
+*/
+public void addSummaryLabel(Content memberTree) {
-public void printTableSummary() {
+Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
-writer.tableIndexSummary(configuration().getText("doclet.Member_Table_Summary",
+writer.getResource("doclet.Method_Summary"));
+memberTree.addContent(label);
+}
+/**
+* {@inheritDoc}
+*/
+public String getTableSummary() {
+return configuration().getText("doclet.Member_Table_Summary",
 configuration().getText("doclet.Method_Summary"),
-configuration().getText("doclet.methods")));
+configuration().getText("doclet.methods"));
 }
-public void printSummaryTableHeader(ProgramElementDoc member) {
+/**
+* {@inheritDoc}
+*/
+public String getCaption() {
+return configuration().getText("doclet.Methods");
+}
+/**
+* {@inheritDoc}
+*/
+public String[] getSummaryTableHeader(ProgramElementDoc member) {
 String[] header = new String[] {
 writer.getModifierTypeHeader(),
 configuration().getText("doclet.0_and_1",
 configuration().getText("doclet.Method"),
 configuration().getText("doclet.Description"))
 };
-writer.summaryTableHeader(header, "col");
+return header;
 }
-public void printSummaryAnchor(ClassDoc cd) {
+/**
-writer.anchor("method_summary");
+* {@inheritDoc}
-}
+*/
+public void addSummaryAnchor(ClassDoc cd, Content memberTree) {
-public void printInheritedSummaryAnchor(ClassDoc cd) {
+memberTree.addContent(writer.getMarkerAnchor("method_summary"));
-writer.anchor("methods_inherited_from_class_" +
+}
-ConfigurationImpl.getInstance().getClassName(cd));
-}
+/**
+* {@inheritDoc}
-public void printInheritedSummaryLabel(ClassDoc cd) {
+*/
-String classlink = writer.getPreQualifiedClassLink(
+public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) {
-LinkInfoImpl.CONTEXT_MEMBER, cd, false);
+inheritedTree.addContent(writer.getMarkerAnchor(
-writer.strong();
+"methods_inherited_from_class_" +
-String key = cd.isClass()?
+configuration().getClassName(cd)));
-"doclet.Methods_Inherited_From_Class" :
+}
-"doclet.Methods_Inherited_From_Interface";
-writer.printText(key, classlink);
+/**
-writer.strongEnd();
+* {@inheritDoc}
-}
+*/
+public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) {
-protected void printSummaryType(ProgramElementDoc member) {
+Content classLink = new RawHtml(writer.getPreQualifiedClassLink(
+LinkInfoImpl.CONTEXT_MEMBER, cd, false));
+Content label = new StringContent(cd.isClass() ?
+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);
+}
+/**
+* {@inheritDoc}
+*/
+protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) {
 MethodDoc meth = (MethodDoc)member;
-printModifierAndType(meth, meth.returnType());
+addModifierAndType(meth, meth.returnType(), tdSummaryType);
 }
-protected static void printOverridden(HtmlDocletWriter writer,
+/**
-Type overriddenType, MethodDoc method) {
+* {@inheritDoc}
+*/
+protected static void addOverridden(HtmlDocletWriter writer,
+Type overriddenType, MethodDoc method, Content dl) {
 if(writer.configuration.nocomment){
 return;
 }
 ClassDoc holderClassDoc = overriddenType.asClassDoc();
 if (! (holderClassDoc.isPublic() ||
 if (overriddenType.asClassDoc().isIncluded() && ! method.isIncluded()) {
 //The class is included but the method is not.  That means that it
 //is not visible so don't document this.
 return;
 }
-String label = "doclet.Overrides";
+Content label = writer.overridesLabel;
 int context = LinkInfoImpl.CONTEXT_METHOD_OVERRIDES;
 if (method != null) {
 if(overriddenType.asClassDoc().isAbstract() && method.isAbstract()){
 //Abstract method is implemented from abstract class,
 //not overridden
-label = "doclet.Specified_By";
+label = writer.specifiedByLabel;
 context = LinkInfoImpl.CONTEXT_METHOD_SPECIFIED_BY;
 }
-String overriddenTypeLink = writer.codeText(
+Content dt = HtmlTree.DT(HtmlTree.STRONG(label));
-writer.getLink(new LinkInfoImpl(context, overriddenType)));
+dl.addContent(dt);
+Content overriddenTypeLink = new RawHtml(
+writer.getLink(new LinkInfoImpl(context, overriddenType)));
+Content codeOverridenTypeLink = HtmlTree.CODE(overriddenTypeLink);
 String name = method.name();
-writer.dt();
+Content methlink = new RawHtml(writer.getLink(
-writer.strongText(label);
-writer.dtEnd();
-writer.dd();
-String methLink = writer.codeText(
-writer.getLink(
 new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER,
 overriddenType.asClassDoc(),
-writer.getAnchor(method), name, false)
+writer.getAnchor(method), name, false)));
-));
+Content codeMethLink = HtmlTree.CODE(methlink);
-writer.printText("doclet.in_class", methLink, overriddenTypeLink);
+Content dd = HtmlTree.DD(codeMethLink);
-writer.ddEnd();
+dd.addContent(writer.getSpace());
+dd.addContent(writer.getResource("doclet.in_class"));
+dd.addContent(writer.getSpace());
+dd.addContent(codeOverridenTypeLink);
+dl.addContent(dd);
 }
 }
 /**
 * Parse the &lt;Code&gt; tag and return the text.
 } else {
 return tag.substring(begin + 6, end);
 }
 }
-protected static void printImplementsInfo(HtmlDocletWriter writer,
+/**
-MethodDoc method) {
+* {@inheritDoc}
+*/
+protected static void addImplementsInfo(HtmlDocletWriter writer,
+MethodDoc method, Content dl) {
 if(writer.configuration.nocomment){
 return;
 }
 ImplementedMethods implementedMethodsFinder =
 new ImplementedMethods(method, writer.configuration);
 MethodDoc[] implementedMethods = implementedMethodsFinder.build();
 for (int i = 0; i < implementedMethods.length; i++) {
 MethodDoc implementedMeth = implementedMethods[i];
 Type intfac = implementedMethodsFinder.getMethodHolder(implementedMeth);
-String methlink = "";
+Content intfaclink = new RawHtml(writer.getLink(new LinkInfoImpl(
-String intfaclink = writer.codeText(
-writer.getLink(new LinkInfoImpl(
 LinkInfoImpl.CONTEXT_METHOD_SPECIFIED_BY, intfac)));
-writer.dt();
+Content codeIntfacLink = HtmlTree.CODE(intfaclink);
-writer.strongText("doclet.Specified_By");
+Content dt = HtmlTree.DT(HtmlTree.STRONG(writer.specifiedByLabel));
-writer.dtEnd();
+dl.addContent(dt);
-writer.dd();
+Content methlink = new RawHtml(writer.getDocLink(
-methlink = writer.codeText(writer.getDocLink(
+LinkInfoImpl.CONTEXT_MEMBER, implementedMeth,
-LinkInfoImpl.CONTEXT_MEMBER, implementedMeth,
+implementedMeth.name(), false));
-implementedMeth.name(), false));
+Content codeMethLink = HtmlTree.CODE(methlink);
-writer.printText("doclet.in_interface", methlink, intfaclink);
+Content dd = HtmlTree.DD(codeMethLink);
-writer.ddEnd();
+dd.addContent(writer.getSpace());
-}
+dd.addContent(writer.getResource("doclet.in_interface"));
+dd.addContent(writer.getSpace());
-}
+dd.addContent(codeIntfacLink);
+dl.addContent(dd);
-protected void printReturnType(MethodDoc method) {
+}
+}
+/**
+* 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();
 if (type != null) {
-writer.printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_RETURN_TYPE,
+Content linkContent = new RawHtml(writer.getLink(
-type));
+new LinkInfoImpl(LinkInfoImpl.CONTEXT_RETURN_TYPE, type)));
-print(' ');
+htmltree.addContent(linkContent);
-}
+htmltree.addContent(writer.getSpace());
 }
+}
-protected void printNavSummaryLink(ClassDoc cd, boolean link) {
+/**
+* {@inheritDoc}
+*/
+protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
 if (link) {
-writer.printHyperLink("", (cd == null)?
+return writer.getHyperLink("", (cd == null)?
 "method_summary":
 "methods_inherited_from_class_" +
-ConfigurationImpl.getInstance().getClassName(cd),
+configuration().getClassName(cd),
-ConfigurationImpl.getInstance().getText("doclet.navMethod"));
+writer.getResource("doclet.navMethod"));
 } else {
-writer.printText("doclet.navMethod");
+return writer.getResource("doclet.navMethod");
 }
 }
-protected void printNavDetailLink(boolean link) {
+/**
+* {@inheritDoc}
+*/
+protected void addNavDetailLink(boolean link, Content liNav) {
 if (link) {
-writer.printHyperLink("", "method_detail",
+liNav.addContent(writer.getHyperLink("", "method_detail",
-ConfigurationImpl.getInstance().getText("doclet.navMethod"));
+writer.getResource("doclet.navMethod")));
 } else {
-writer.printText("doclet.navMethod");
+liNav.addContent(writer.getResource("doclet.navMethod"));
 }
 }
 }

Mercurial > jdk8-mips64-public > langtools / file comparison

comparison: src/share/classes/com/sun/tools/doclets/formats/html/MethodWriterImpl.java

src/share/classes/com/sun/tools/doclets/formats/html/MethodWriterImpl.java