duke@1: /*
jjg@1357:  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.internal.toolkit.builders;
duke@1: 
bpatel@766: import java.util.*;
jjg@1357: 
jjg@1357: import com.sun.javadoc.*;
jjg@1357: import com.sun.tools.doclets.internal.toolkit.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
jjg@589: 
duke@1: /**
duke@1:  * Builds documentation for a method.
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
duke@1:  *
duke@1:  * @author Jamie Ho
bpatel@766:  * @author Bhavesh Patel (Modified)
duke@1:  * @since 1.5
duke@1:  */
duke@1: public class MethodBuilder extends AbstractMemberBuilder {
duke@1: 
bpatel@766:     /**
bpatel@766:      * The index of the current field that is being documented at this point
bpatel@766:      * in time.
bpatel@766:      */
bpatel@766:     private int currentMethodIndex;
duke@1: 
bpatel@766:     /**
bpatel@766:      * The class whose methods are being documented.
bpatel@766:      */
jjg@1410:     private final ClassDoc classDoc;
duke@1: 
bpatel@766:     /**
bpatel@766:      * The visible methods for the given class.
bpatel@766:      */
jjg@1410:     private final VisibleMemberMap visibleMemberMap;
duke@1: 
bpatel@766:     /**
bpatel@766:      * The writer to output the method documentation.
bpatel@766:      */
jjg@1410:     private final MethodWriter writer;
duke@1: 
bpatel@766:     /**
bpatel@766:      * The methods being documented.
bpatel@766:      */
bpatel@766:     private List<ProgramElementDoc> methods;
duke@1: 
jjg@1410: 
jjg@1410:     /**
jjg@1410:      * Construct a new MethodBuilder.
jjg@1410:      *
jjg@1410:      * @param context       the build context.
jjg@1410:      * @param classDoc the class whoses members are being documented.
jjg@1410:      * @param writer the doclet specific writer.
jjg@1410:      */
jjg@1410:     private MethodBuilder(Context context,
jjg@1410:             ClassDoc classDoc,
jjg@1410:             MethodWriter writer) {
jjg@1410:         super(context);
jjg@1410:         this.classDoc = classDoc;
jjg@1410:         this.writer = writer;
jjg@1410:         visibleMemberMap = new VisibleMemberMap(
jjg@1410:                 classDoc,
jjg@1410:                 VisibleMemberMap.METHODS,
jjg@1410:                 configuration.nodeprecated);
jjg@1410:         methods =
jjg@1410:                 new ArrayList<ProgramElementDoc>(visibleMemberMap.getLeafClassMembers(
jjg@1410:                 configuration));
jjg@1410:         if (configuration.getMemberComparator() != null) {
jjg@1410:             Collections.sort(methods, configuration.getMemberComparator());
jjg@1410:         }
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Construct a new MethodBuilder.
bpatel@766:      *
jjg@1410:      * @param context       the build context.
bpatel@766:      * @param classDoc the class whoses members are being documented.
bpatel@766:      * @param writer the doclet specific writer.
bpatel@766:      *
bpatel@766:      * @return an instance of a MethodBuilder.
bpatel@766:      */
jjg@1410:     public static MethodBuilder getInstance(Context context,
jjg@1410:             ClassDoc classDoc, MethodWriter writer) {
jjg@1410:         return new MethodBuilder(context, classDoc, writer);
bpatel@766:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public String getName() {
bpatel@766:         return "MethodDetails";
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Returns a list of methods that will be documented for the given class.
bpatel@766:      * This information can be used for doclet specific documentation
bpatel@766:      * generation.
bpatel@766:      *
bpatel@766:      * @param classDoc the {@link ClassDoc} we want to check.
bpatel@766:      * @return a list of methods that will be documented.
bpatel@766:      */
bpatel@766:     public List<ProgramElementDoc> members(ClassDoc classDoc) {
bpatel@766:         return visibleMemberMap.getMembersFor(classDoc);
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Returns the visible member map for the methods of this class.
bpatel@766:      *
bpatel@766:      * @return the visible member map for the methods of this class.
bpatel@766:      */
bpatel@766:     public VisibleMemberMap getVisibleMemberMap() {
bpatel@766:         return visibleMemberMap;
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public boolean hasMembersToDocument() {
bpatel@766:         return methods.size() > 0;
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the method documentation.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param memberDetailsTree the content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildMethodDoc(XMLNode node, Content memberDetailsTree) {
bpatel@766:         if (writer == null) {
bpatel@766:             return;
duke@1:         }
bpatel@766:         int size = methods.size();
bpatel@766:         if (size > 0) {
bpatel@766:             Content methodDetailsTree = writer.getMethodDetailsTreeHeader(
bpatel@766:                     classDoc, memberDetailsTree);
bpatel@766:             for (currentMethodIndex = 0; currentMethodIndex < size;
bpatel@766:                     currentMethodIndex++) {
bpatel@766:                 Content methodDocTree = writer.getMethodDocTreeHeader(
bpatel@766:                         (MethodDoc) methods.get(currentMethodIndex),
bpatel@766:                         methodDetailsTree);
bpatel@766:                 buildChildren(node, methodDocTree);
bpatel@766:                 methodDetailsTree.addContent(writer.getMethodDoc(
bpatel@766:                         methodDocTree, (currentMethodIndex == size - 1)));
bpatel@766:             }
bpatel@766:             memberDetailsTree.addContent(
bpatel@766:                     writer.getMethodDetails(methodDetailsTree));
bpatel@766:         }
bpatel@766:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * Build the signature.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param methodDocTree the content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildSignature(XMLNode node, Content methodDocTree) {
bpatel@766:         methodDocTree.addContent(
bpatel@766:                 writer.getSignature((MethodDoc) methods.get(currentMethodIndex)));
bpatel@766:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * Build the deprecation information.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param methodDocTree the content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildDeprecationInfo(XMLNode node, Content methodDocTree) {
bpatel@766:         writer.addDeprecated(
bpatel@766:                 (MethodDoc) methods.get(currentMethodIndex), methodDocTree);
bpatel@766:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * Build the comments for the method.  Do nothing if
bpatel@766:      * {@link Configuration#nocomment} is set to true.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param methodDocTree the content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildMethodComments(XMLNode node, Content methodDocTree) {
bpatel@766:         if (!configuration.nocomment) {
duke@1:             MethodDoc method = (MethodDoc) methods.get(currentMethodIndex);
duke@1: 
duke@1:             if (method.inlineTags().length == 0) {
duke@1:                 DocFinder.Output docs = DocFinder.search(
bpatel@766:                         new DocFinder.Input(method));
duke@1:                 method = docs.inlineTags != null && docs.inlineTags.length > 0 ?
duke@1:                     (MethodDoc) docs.holder : method;
duke@1:             }
duke@1:             //NOTE:  When we fix the bug where ClassDoc.interfaceTypes() does
duke@1:             //       not pass all implemented interfaces, holder will be the
duke@1:             //       interface type.  For now, it is really the erasure.
bpatel@766:             writer.addComments(method.containingClass(), method, methodDocTree);
duke@1:         }
bpatel@766:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * Build the tag information.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param methodDocTree the content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildTagInfo(XMLNode node, Content methodDocTree) {
bpatel@766:         writer.addTags((MethodDoc) methods.get(currentMethodIndex),
bpatel@766:                 methodDocTree);
bpatel@766:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * Return the method writer for this builder.
bpatel@766:      *
bpatel@766:      * @return the method writer for this builder.
bpatel@766:      */
bpatel@766:     public MethodWriter getWriter() {
bpatel@766:         return writer;
bpatel@766:     }
duke@1: }