0N/A/*
797N/A * Copyright (c) 2003, 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.internal.toolkit.builders;
0N/A
765N/Aimport java.util.*;
0N/Aimport com.sun.tools.doclets.internal.toolkit.util.*;
0N/Aimport com.sun.tools.doclets.internal.toolkit.*;
0N/Aimport com.sun.javadoc.*;
588N/A
0N/A/**
0N/A * Builds documentation for a method.
0N/A *
0N/A * This code is not part of an API.
0N/A * It is implementation that is subject to change.
0N/A * Do not use it as an API
0N/A *
0N/A * @author Jamie Ho
765N/A * @author Bhavesh Patel (Modified)
0N/A * @since 1.5
0N/A */
0N/Apublic class MethodBuilder extends AbstractMemberBuilder {
0N/A
765N/A /**
765N/A * The index of the current field that is being documented at this point
765N/A * in time.
765N/A */
765N/A private int currentMethodIndex;
0N/A
765N/A /**
765N/A * The class whose methods are being documented.
765N/A */
765N/A private ClassDoc classDoc;
0N/A
765N/A /**
765N/A * The visible methods for the given class.
765N/A */
765N/A private VisibleMemberMap visibleMemberMap;
0N/A
765N/A /**
765N/A * The writer to output the method documentation.
765N/A */
765N/A private MethodWriter writer;
0N/A
765N/A /**
765N/A * The methods being documented.
765N/A */
765N/A private List<ProgramElementDoc> methods;
0N/A
765N/A private MethodBuilder(Configuration configuration) {
765N/A super(configuration);
765N/A }
0N/A
765N/A /**
765N/A * Construct a new MethodBuilder.
765N/A *
765N/A * @param configuration the current configuration of the doclet.
765N/A * @param classDoc the class whoses members are being documented.
765N/A * @param writer the doclet specific writer.
765N/A *
765N/A * @return an instance of a MethodBuilder.
765N/A */
765N/A public static MethodBuilder getInstance(
765N/A Configuration configuration,
765N/A ClassDoc classDoc,
765N/A MethodWriter writer) {
765N/A MethodBuilder builder = new MethodBuilder(configuration);
765N/A builder.classDoc = classDoc;
765N/A builder.writer = writer;
765N/A builder.visibleMemberMap =
765N/A new VisibleMemberMap(
765N/A classDoc,
765N/A VisibleMemberMap.METHODS,
765N/A configuration.nodeprecated);
765N/A builder.methods =
765N/A new ArrayList<ProgramElementDoc>(builder.visibleMemberMap.getLeafClassMembers(
0N/A configuration));
765N/A if (configuration.getMemberComparator() != null) {
765N/A Collections.sort(
765N/A builder.methods,
765N/A configuration.getMemberComparator());
0N/A }
765N/A return builder;
765N/A }
0N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A public String getName() {
765N/A return "MethodDetails";
765N/A }
0N/A
765N/A /**
765N/A * Returns a list of methods that will be documented for the given class.
765N/A * This information can be used for doclet specific documentation
765N/A * generation.
765N/A *
765N/A * @param classDoc the {@link ClassDoc} we want to check.
765N/A * @return a list of methods that will be documented.
765N/A */
765N/A public List<ProgramElementDoc> members(ClassDoc classDoc) {
765N/A return visibleMemberMap.getMembersFor(classDoc);
765N/A }
0N/A
765N/A /**
765N/A * Returns the visible member map for the methods of this class.
765N/A *
765N/A * @return the visible member map for the methods of this class.
765N/A */
765N/A public VisibleMemberMap getVisibleMemberMap() {
765N/A return visibleMemberMap;
765N/A }
0N/A
765N/A /**
765N/A * {@inheritDoc}
765N/A */
765N/A public boolean hasMembersToDocument() {
765N/A return methods.size() > 0;
765N/A }
0N/A
765N/A /**
765N/A * Build the method documentation.
765N/A *
765N/A * @param node the XML element that specifies which components to document
765N/A * @param memberDetailsTree the content tree to which the documentation will be added
765N/A */
765N/A public void buildMethodDoc(XMLNode node, Content memberDetailsTree) {
765N/A if (writer == null) {
765N/A return;
0N/A }
765N/A int size = methods.size();
765N/A if (size > 0) {
765N/A Content methodDetailsTree = writer.getMethodDetailsTreeHeader(
765N/A classDoc, memberDetailsTree);
765N/A for (currentMethodIndex = 0; currentMethodIndex < size;
765N/A currentMethodIndex++) {
765N/A Content methodDocTree = writer.getMethodDocTreeHeader(
765N/A (MethodDoc) methods.get(currentMethodIndex),
765N/A methodDetailsTree);
765N/A buildChildren(node, methodDocTree);
765N/A methodDetailsTree.addContent(writer.getMethodDoc(
765N/A methodDocTree, (currentMethodIndex == size - 1)));
765N/A }
765N/A memberDetailsTree.addContent(
765N/A writer.getMethodDetails(methodDetailsTree));
0N/A }
765N/A }
0N/A
765N/A /**
765N/A * Build the signature.
765N/A *
765N/A * @param node the XML element that specifies which components to document
765N/A * @param methodDocTree the content tree to which the documentation will be added
765N/A */
765N/A public void buildSignature(XMLNode node, Content methodDocTree) {
765N/A methodDocTree.addContent(
765N/A writer.getSignature((MethodDoc) methods.get(currentMethodIndex)));
765N/A }
0N/A
765N/A /**
765N/A * Build the deprecation information.
765N/A *
765N/A * @param node the XML element that specifies which components to document
765N/A * @param methodDocTree the content tree to which the documentation will be added
765N/A */
765N/A public void buildDeprecationInfo(XMLNode node, Content methodDocTree) {
765N/A writer.addDeprecated(
765N/A (MethodDoc) methods.get(currentMethodIndex), methodDocTree);
765N/A }
0N/A
765N/A /**
765N/A * Build the comments for the method. Do nothing if
765N/A * {@link Configuration#nocomment} is set to true.
765N/A *
765N/A * @param node the XML element that specifies which components to document
765N/A * @param methodDocTree the content tree to which the documentation will be added
765N/A */
765N/A public void buildMethodComments(XMLNode node, Content methodDocTree) {
765N/A if (!configuration.nocomment) {
0N/A MethodDoc method = (MethodDoc) methods.get(currentMethodIndex);
0N/A
0N/A if (method.inlineTags().length == 0) {
0N/A DocFinder.Output docs = DocFinder.search(
765N/A new DocFinder.Input(method));
0N/A method = docs.inlineTags != null && docs.inlineTags.length > 0 ?
0N/A (MethodDoc) docs.holder : method;
0N/A }
0N/A //NOTE: When we fix the bug where ClassDoc.interfaceTypes() does
0N/A // not pass all implemented interfaces, holder will be the
0N/A // interface type. For now, it is really the erasure.
765N/A writer.addComments(method.containingClass(), method, methodDocTree);
0N/A }
765N/A }
0N/A
765N/A /**
765N/A * Build the tag information.
765N/A *
765N/A * @param node the XML element that specifies which components to document
765N/A * @param methodDocTree the content tree to which the documentation will be added
765N/A */
765N/A public void buildTagInfo(XMLNode node, Content methodDocTree) {
765N/A writer.addTags((MethodDoc) methods.get(currentMethodIndex),
765N/A methodDocTree);
765N/A }
0N/A
765N/A /**
765N/A * Return the method writer for this builder.
765N/A *
765N/A * @return the method writer for this builder.
765N/A */
765N/A public MethodWriter getWriter() {
765N/A return writer;
765N/A }
0N/A}