0N/A/*
797N/A * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
553N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
553N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
553N/A * or visit www.oracle.com if you need additional information or have any
553N/A * questions.
0N/A */
0N/A
0N/Apackage com.sun.tools.doclets.formats.html;
0N/A
232N/Aimport java.io.*;
232N/A
232N/Aimport com.sun.javadoc.*;
765N/Aimport com.sun.tools.doclets.formats.html.markup.*;
0N/Aimport com.sun.tools.doclets.internal.toolkit.*;
0N/Aimport com.sun.tools.doclets.internal.toolkit.util.*;
0N/A
0N/A/**
0N/A * Writes method documentation in HTML format.
0N/A *
0N/A * @author Robert Field
0N/A * @author Atul M Dambalkar
0N/A * @author Jamie Ho (rewrite)
242N/A * @author Bhavesh Patel (Modified)
0N/A */
0N/Apublic class MethodWriterImpl extends AbstractExecutableMemberWriter
0N/A implements MethodWriter, MemberSummaryWriter {
0N/A
0N/A /**
0N/A * Construct a new MethodWriterImpl.
0N/A *
0N/A * @param writer the writer for the class that the methods belong to.
0N/A * @param classDoc the class being documented.
0N/A */
0N/A public MethodWriterImpl(SubWriterHolderWriter writer, ClassDoc classDoc) {
0N/A super(writer, classDoc);
0N/A }
0N/A
0N/A /**
0N/A * Construct a new MethodWriterImpl.
0N/A *
0N/A * @param writer The writer for the class that the methods belong to.
0N/A */
0N/A public MethodWriterImpl(SubWriterHolderWriter writer) {
0N/A super(writer);
0N/A }
0N/A
0N/A /**
765N/A * {@inheritDoc}
0N/A */
765N/A public Content getMemberSummaryHeader(ClassDoc classDoc,
765N/A Content memberSummaryTree) {
765N/A memberSummaryTree.addContent(HtmlConstants.START_OF_METHOD_SUMMARY);
765N/A Content memberTree = writer.getMemberTreeHeader();
765N/A writer.addSummaryHeader(this, classDoc, memberTree);
765N/A return memberTree;
0N/A }
0N/A
0N/A /**
765N/A * {@inheritDoc}
0N/A */
765N/A public Content getMethodDetailsTreeHeader(ClassDoc classDoc,
765N/A Content memberDetailsTree) {
765N/A memberDetailsTree.addContent(HtmlConstants.START_OF_METHOD_DETAILS);
765N/A Content methodDetailsTree = writer.getMemberTreeHeader();
765N/A methodDetailsTree.addContent(writer.getMarkerAnchor("method_detail"));
765N/A Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
765N/A writer.methodDetailsLabel);
765N/A methodDetailsTree.addContent(heading);
765N/A return methodDetailsTree;
0N/A }
0N/A
0N/A /**
0N/A * {@inheritDoc}
0N/A */
765N/A public Content getMethodDocTreeHeader(MethodDoc method,
765N/A Content methodDetailsTree) {
0N/A String erasureAnchor;
0N/A if ((erasureAnchor = getErasureAnchor(method)) != null) {
765N/A methodDetailsTree.addContent(writer.getMarkerAnchor((erasureAnchor)));
0N/A }
765N/A methodDetailsTree.addContent(
765N/A writer.getMarkerAnchor(writer.getAnchor(method)));
765N/A Content methodDocTree = writer.getMemberTreeHeader();
765N/A Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
765N/A heading.addContent(method.name());
765N/A methodDocTree.addContent(heading);
765N/A return methodDocTree;
0N/A }
0N/A
0N/A /**
765N/A * Get the signature for the given method.
0N/A *
0N/A * @param method the method being documented.
765N/A * @return a content object for the signature
0N/A */
765N/A public Content getSignature(MethodDoc method) {
0N/A writer.displayLength = 0;
765N/A Content pre = new HtmlTree(HtmlTag.PRE);
765N/A writer.addAnnotationInfo(method, pre);
765N/A addModifiers(method, pre);
765N/A addTypeParameters(method, pre);
765N/A addReturnType(method, pre);
0N/A if (configuration().linksource) {
765N/A Content methodName = new StringContent(method.name());
765N/A writer.addSrcLink(method, methodName, pre);
0N/A } else {
765N/A addName(method.name(), pre);
0N/A }
765N/A addParameters(method, pre);
765N/A addExceptions(method, pre);
765N/A return pre;
0N/A }
0N/A
0N/A /**
765N/A * {@inheritDoc}
0N/A */
765N/A public void addDeprecated(MethodDoc method, Content methodDocTree) {
765N/A addDeprecatedInfo(method, methodDocTree);
0N/A }
0N/A
0N/A /**
765N/A * {@inheritDoc}
0N/A */
765N/A public void addComments(Type holder, MethodDoc method, Content methodDocTree) {
0N/A ClassDoc holderClassDoc = holder.asClassDoc();
0N/A if (method.inlineTags().length > 0) {
0N/A if (holder.asClassDoc().equals(classdoc) ||
765N/A (! (holderClassDoc.isPublic() ||
0N/A Util.isLinkable(holderClassDoc, configuration())))) {
765N/A writer.addInlineComment(method, methodDocTree);
0N/A } else {
765N/A Content link = new RawHtml(
765N/A writer.getDocLink(LinkInfoImpl.CONTEXT_METHOD_DOC_COPY,
0N/A holder.asClassDoc(), method,
0N/A holder.asClassDoc().isIncluded() ?
0N/A holder.typeName() : holder.qualifiedTypeName(),
765N/A false));
765N/A Content codelLink = HtmlTree.CODE(link);
765N/A Content strong = HtmlTree.STRONG(holder.asClassDoc().isClass()?
765N/A writer.descfrmClassLabel : writer.descfrmInterfaceLabel);
765N/A strong.addContent(writer.getSpace());
765N/A strong.addContent(codelLink);
765N/A methodDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, strong));
765N/A writer.addInlineComment(method, methodDocTree);
0N/A }
0N/A }
0N/A }
0N/A
0N/A /**
765N/A * {@inheritDoc}
0N/A */
765N/A public void addTags(MethodDoc method, Content methodDocTree) {
765N/A writer.addTagsInfo(method, methodDocTree);
0N/A }
0N/A
0N/A /**
765N/A * {@inheritDoc}
0N/A */
765N/A public Content getMethodDetails(Content methodDetailsTree) {
765N/A return getMemberTree(methodDetailsTree);
0N/A }
0N/A
0N/A /**
765N/A * {@inheritDoc}
0N/A */
765N/A public Content getMethodDoc(Content methodDocTree,
765N/A boolean isLastContent) {
765N/A return getMemberTree(methodDocTree, isLastContent);
0N/A }
0N/A
0N/A /**
0N/A * Close the writer.
0N/A */
0N/A public void close() throws IOException {
0N/A writer.close();
0N/A }
0N/A
0N/A public int getMemberKind() {
0N/A return VisibleMemberMap.METHODS;
0N/A }
0N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A public void addSummaryLabel(Content memberTree) {
765N/A Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
765N/A writer.getResource("doclet.Method_Summary"));
765N/A memberTree.addContent(label);
242N/A }
242N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A public String getTableSummary() {
765N/A return configuration().getText("doclet.Member_Table_Summary",
242N/A configuration().getText("doclet.Method_Summary"),
765N/A configuration().getText("doclet.methods"));
242N/A }
242N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A public String getCaption() {
765N/A return configuration().getText("doclet.Methods");
765N/A }
765N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A public String[] getSummaryTableHeader(ProgramElementDoc member) {
242N/A String[] header = new String[] {
242N/A writer.getModifierTypeHeader(),
242N/A configuration().getText("doclet.0_and_1",
242N/A configuration().getText("doclet.Method"),
242N/A configuration().getText("doclet.Description"))
242N/A };
765N/A return header;
0N/A }
0N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A public void addSummaryAnchor(ClassDoc cd, Content memberTree) {
765N/A memberTree.addContent(writer.getMarkerAnchor("method_summary"));
0N/A }
0N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) {
765N/A inheritedTree.addContent(writer.getMarkerAnchor(
765N/A "methods_inherited_from_class_" +
765N/A configuration().getClassName(cd)));
0N/A }
0N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) {
765N/A Content classLink = new RawHtml(writer.getPreQualifiedClassLink(
765N/A LinkInfoImpl.CONTEXT_MEMBER, cd, false));
765N/A Content label = new StringContent(cd.isClass() ?
765N/A configuration().getText("doclet.Methods_Inherited_From_Class") :
765N/A configuration().getText("doclet.Methods_Inherited_From_Interface"));
765N/A Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING,
765N/A label);
765N/A labelHeading.addContent(writer.getSpace());
765N/A labelHeading.addContent(classLink);
765N/A inheritedTree.addContent(labelHeading);
0N/A }
0N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) {
0N/A MethodDoc meth = (MethodDoc)member;
765N/A addModifierAndType(meth, meth.returnType(), tdSummaryType);
0N/A }
0N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A protected static void addOverridden(HtmlDocletWriter writer,
765N/A Type overriddenType, MethodDoc method, Content dl) {
0N/A if(writer.configuration.nocomment){
0N/A return;
0N/A }
0N/A ClassDoc holderClassDoc = overriddenType.asClassDoc();
0N/A if (! (holderClassDoc.isPublic() ||
0N/A Util.isLinkable(holderClassDoc, writer.configuration()))) {
0N/A //This is an implementation detail that should not be documented.
0N/A return;
0N/A }
0N/A if (overriddenType.asClassDoc().isIncluded() && ! method.isIncluded()) {
0N/A //The class is included but the method is not. That means that it
0N/A //is not visible so don't document this.
0N/A return;
0N/A }
765N/A Content label = writer.overridesLabel;
0N/A int context = LinkInfoImpl.CONTEXT_METHOD_OVERRIDES;
0N/A
0N/A if (method != null) {
0N/A if(overriddenType.asClassDoc().isAbstract() && method.isAbstract()){
0N/A //Abstract method is implemented from abstract class,
0N/A //not overridden
765N/A label = writer.specifiedByLabel;
0N/A context = LinkInfoImpl.CONTEXT_METHOD_SPECIFIED_BY;
0N/A }
765N/A Content dt = HtmlTree.DT(HtmlTree.STRONG(label));
765N/A dl.addContent(dt);
765N/A Content overriddenTypeLink = new RawHtml(
765N/A writer.getLink(new LinkInfoImpl(context, overriddenType)));
765N/A Content codeOverridenTypeLink = HtmlTree.CODE(overriddenTypeLink);
0N/A String name = method.name();
765N/A Content methlink = new RawHtml(writer.getLink(
0N/A new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER,
765N/A overriddenType.asClassDoc(),
765N/A writer.getAnchor(method), name, false)));
765N/A Content codeMethLink = HtmlTree.CODE(methlink);
765N/A Content dd = HtmlTree.DD(codeMethLink);
765N/A dd.addContent(writer.getSpace());
765N/A dd.addContent(writer.getResource("doclet.in_class"));
765N/A dd.addContent(writer.getSpace());
765N/A dd.addContent(codeOverridenTypeLink);
765N/A dl.addContent(dd);
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Parse the <Code> tag and return the text.
0N/A */
0N/A protected String parseCodeTag(String tag){
0N/A if(tag == null){
0N/A return "";
0N/A }
0N/A
0N/A String lc = tag.toLowerCase();
0N/A int begin = lc.indexOf("<code>");
0N/A int end = lc.indexOf("</code>");
0N/A if(begin == -1 || end == -1 || end <= begin){
0N/A return tag;
0N/A } else {
0N/A return tag.substring(begin + 6, end);
0N/A }
0N/A }
0N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A protected static void addImplementsInfo(HtmlDocletWriter writer,
765N/A MethodDoc method, Content dl) {
0N/A if(writer.configuration.nocomment){
0N/A return;
0N/A }
0N/A ImplementedMethods implementedMethodsFinder =
765N/A new ImplementedMethods(method, writer.configuration);
0N/A MethodDoc[] implementedMethods = implementedMethodsFinder.build();
0N/A for (int i = 0; i < implementedMethods.length; i++) {
0N/A MethodDoc implementedMeth = implementedMethods[i];
0N/A Type intfac = implementedMethodsFinder.getMethodHolder(implementedMeth);
765N/A Content intfaclink = new RawHtml(writer.getLink(new LinkInfoImpl(
0N/A LinkInfoImpl.CONTEXT_METHOD_SPECIFIED_BY, intfac)));
765N/A Content codeIntfacLink = HtmlTree.CODE(intfaclink);
765N/A Content dt = HtmlTree.DT(HtmlTree.STRONG(writer.specifiedByLabel));
765N/A dl.addContent(dt);
765N/A Content methlink = new RawHtml(writer.getDocLink(
765N/A LinkInfoImpl.CONTEXT_MEMBER, implementedMeth,
765N/A implementedMeth.name(), false));
765N/A Content codeMethLink = HtmlTree.CODE(methlink);
765N/A Content dd = HtmlTree.DD(codeMethLink);
765N/A dd.addContent(writer.getSpace());
765N/A dd.addContent(writer.getResource("doclet.in_interface"));
765N/A dd.addContent(writer.getSpace());
765N/A dd.addContent(codeIntfacLink);
765N/A dl.addContent(dd);
0N/A }
0N/A }
0N/A
765N/A /**
765N/A * Add the return type.
765N/A *
765N/A * @param method the method being documented.
765N/A * @param htmltree the content tree to which the return type will be added
765N/A */
765N/A protected void addReturnType(MethodDoc method, Content htmltree) {
765N/A Type type = method.returnType();
765N/A if (type != null) {
765N/A Content linkContent = new RawHtml(writer.getLink(
765N/A new LinkInfoImpl(LinkInfoImpl.CONTEXT_RETURN_TYPE, type)));
765N/A htmltree.addContent(linkContent);
765N/A htmltree.addContent(writer.getSpace());
0N/A }
0N/A }
0N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
0N/A if (link) {
765N/A return writer.getHyperLink("", (cd == null)?
765N/A "method_summary":
765N/A "methods_inherited_from_class_" +
765N/A configuration().getClassName(cd),
765N/A writer.getResource("doclet.navMethod"));
0N/A } else {
765N/A return writer.getResource("doclet.navMethod");
765N/A }
765N/A }
765N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A protected void addNavDetailLink(boolean link, Content liNav) {
765N/A if (link) {
765N/A liNav.addContent(writer.getHyperLink("", "method_detail",
765N/A writer.getResource("doclet.navMethod")));
765N/A } else {
765N/A liNav.addContent(writer.getResource("doclet.navMethod"));
0N/A }
0N/A }
0N/A}