PackageSummaryBuilder.java

/*
 * Copyright (c) 2003, 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
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 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.internal.toolkit.builders;

import com.sun.tools.doclets.internal.toolkit.util.*;
import com.sun.tools.doclets.internal.toolkit.*;
import com.sun.javadoc.*;
import java.io.*;

/**
 * Builds the summary for a given package.
 *
 * This code is not part of an API.
 * It is implementation that is subject to change.
 * Do not use it as an API
 *
 * @author Jamie Ho
 * @author Bhavesh Patel (Modified)
 * @since 1.5
 */
public class PackageSummaryBuilder extends AbstractBuilder {

        /**
         * The root element of the package summary XML is {@value}.
         */
        public static final String ROOT = "PackageDoc";

        /**
         * The package being documented.
         */
        private PackageDoc packageDoc;

        /**
         * The doclet specific writer that will output the result.
         */
        private PackageSummaryWriter packageWriter;

        private PackageSummaryBuilder(Configuration configuration) {
                super(configuration);
        }

        /**
         * Construct a new PackageSummaryBuilder.
         * @param configuration the current configuration of the doclet.
         * @param pkg the package being documented.
         * @param packageWriter the doclet specific writer that will output the
         *        result.
         *
         * @return an instance of a PackageSummaryBuilder.
         */
        public static PackageSummaryBuilder getInstance(
                Configuration configuration,
                PackageDoc pkg,
                PackageSummaryWriter packageWriter) {
                PackageSummaryBuilder builder =
                        new PackageSummaryBuilder(configuration);
                builder.packageDoc = pkg;
                builder.packageWriter = packageWriter;
                return builder;
        }

        /**
         * Build the package summary.
         */
        public void build() throws IOException {
                if (packageWriter == null) {
                        //Doclet does not support this output.
                        return;
                }
                build(LayoutParser.getInstance(configuration).parseXML(ROOT));
        }

        /**
         * {@inheritDoc}
         */
        public String getName() {
                return ROOT;
        }

        /**
         * Build the package documentation.
         */
        public void buildPackageDoc(XMLNode node) throws Exception {
                buildChildren(node);
                packageWriter.close();
                Util.copyDocFiles(
                        configuration,
                        Util.getPackageSourcePath(configuration, packageDoc),
                        DirectoryManager.getDirectoryPath(packageDoc)
                                + File.separator
                                + DocletConstants.DOC_FILES_DIR_NAME,
                        true);
        }

        /**
         * Build the header of the summary.
         */
        public void buildPackageHeader(XMLNode node) {
                packageWriter.writePackageHeader(Util.getPackageName(packageDoc));
        }

        /**
         * Build the description of the summary.
         */
        public void buildPackageDescription(XMLNode node) {
                if (configuration.nocomment) {
                        return;
                }
                packageWriter.writePackageDescription();
        }

        /**
         * Build the tags of the summary.
         */
        public void buildPackageTags(XMLNode node) {
                if (configuration.nocomment) {
                        return;
                }
                packageWriter.writePackageTags();
        }

        /**
         * Build the package summary.
         */
        public void buildSummary(XMLNode node) {
                buildChildren(node);
        }

        /**
         * Build the overall header.
         */
        public void buildSummaryHeader(XMLNode node) {
                packageWriter.writeSummaryHeader();
        }

        /**
         * Build the overall footer.
         */
        public void buildSummaryFooter(XMLNode node) {
                packageWriter.writeSummaryFooter();
        }

        /**
         * Build the summary for the classes in this package.
         */
        public void buildClassSummary(XMLNode node) {
            String classTableSummary =
                    configuration.getText("doclet.Member_Table_Summary",
                    configuration.getText("doclet.Class_Summary"),
                    configuration.getText("doclet.classes"));
            String[] classTableHeader = new String[] {
                configuration.getText("doclet.Class"),
                configuration.getText("doclet.Description")
            };
            ClassDoc[] classes =
                        packageDoc.isIncluded()
                                ? packageDoc.ordinaryClasses()
                                : configuration.classDocCatalog.ordinaryClasses(
                                        Util.getPackageName(packageDoc));
                if (classes.length > 0) {
                        packageWriter.writeClassesSummary(
                                classes,
                                configuration.getText("doclet.Class_Summary"),
                                classTableSummary, classTableHeader);
                }
        }

        /**
         * Build the summary for the interfaces in this package.
         */
        public void buildInterfaceSummary(XMLNode node) {
            String interfaceTableSummary =
                    configuration.getText("doclet.Member_Table_Summary",
                    configuration.getText("doclet.Interface_Summary"),
                    configuration.getText("doclet.interfaces"));
            String[] interfaceTableHeader = new String[] {
                configuration.getText("doclet.Interface"),
                configuration.getText("doclet.Description")
            };
            ClassDoc[] interfaces =
                        packageDoc.isIncluded()
                                ? packageDoc.interfaces()
                                : configuration.classDocCatalog.interfaces(
                                        Util.getPackageName(packageDoc));
                if (interfaces.length > 0) {
                        packageWriter.writeClassesSummary(
                                interfaces,
                                configuration.getText("doclet.Interface_Summary"),
                                interfaceTableSummary, interfaceTableHeader);
                }
        }

        /**
         * Build the summary for the enums in this package.
         */
        public void buildAnnotationTypeSummary(XMLNode node) {
            String annotationtypeTableSummary =
                    configuration.getText("doclet.Member_Table_Summary",
                    configuration.getText("doclet.Annotation_Types_Summary"),
                    configuration.getText("doclet.annotationtypes"));
            String[] annotationtypeTableHeader = new String[] {
                configuration.getText("doclet.AnnotationType"),
                configuration.getText("doclet.Description")
            };
            ClassDoc[] annotationTypes =
                        packageDoc.isIncluded()
                                ? packageDoc.annotationTypes()
                                : configuration.classDocCatalog.annotationTypes(
                                        Util.getPackageName(packageDoc));
                if (annotationTypes.length > 0) {
                        packageWriter.writeClassesSummary(
                                annotationTypes,
                                configuration.getText("doclet.Annotation_Types_Summary"),
                                annotationtypeTableSummary, annotationtypeTableHeader);
                }
        }

        /**
         * Build the summary for the enums in this package.
         */
        public void buildEnumSummary(XMLNode node) {
            String enumTableSummary =
                    configuration.getText("doclet.Member_Table_Summary",
                    configuration.getText("doclet.Enum_Summary"),
                    configuration.getText("doclet.enums"));
            String[] enumTableHeader = new String[] {
                configuration.getText("doclet.Enum"),
                configuration.getText("doclet.Description")
            };
            ClassDoc[] enums =
                        packageDoc.isIncluded()
                                ? packageDoc.enums()
                                : configuration.classDocCatalog.enums(
                                        Util.getPackageName(packageDoc));
                if (enums.length > 0) {
                        packageWriter.writeClassesSummary(
                                enums,
                                configuration.getText("doclet.Enum_Summary"),
                                enumTableSummary, enumTableHeader);
                }
        }

        /**
         * Build the summary for the exceptions in this package.
         */
        public void buildExceptionSummary(XMLNode node) {
            String exceptionTableSummary =
                    configuration.getText("doclet.Member_Table_Summary",
                    configuration.getText("doclet.Exception_Summary"),
                    configuration.getText("doclet.exceptions"));
            String[] exceptionTableHeader = new String[] {
                configuration.getText("doclet.Exception"),
                configuration.getText("doclet.Description")
            };
            ClassDoc[] exceptions =
                        packageDoc.isIncluded()
                                ? packageDoc.exceptions()
                                : configuration.classDocCatalog.exceptions(
                                        Util.getPackageName(packageDoc));
                if (exceptions.length > 0) {
                        packageWriter.writeClassesSummary(
                                exceptions,
                                configuration.getText("doclet.Exception_Summary"),
                                exceptionTableSummary, exceptionTableHeader);
                }
        }

        /**
         * Build the summary for the errors in this package.
         */
        public void buildErrorSummary(XMLNode node) {
            String errorTableSummary =
                    configuration.getText("doclet.Member_Table_Summary",
                    configuration.getText("doclet.Error_Summary"),
                    configuration.getText("doclet.errors"));
            String[] errorTableHeader = new String[] {
                configuration.getText("doclet.Error"),
                configuration.getText("doclet.Description")
            };
            ClassDoc[] errors =
                        packageDoc.isIncluded()
                                ? packageDoc.errors()
                                : configuration.classDocCatalog.errors(
                                        Util.getPackageName(packageDoc));
                if (errors.length > 0) {
                        packageWriter.writeClassesSummary(
                                errors,
                                configuration.getText("doclet.Error_Summary"),
                                errorTableSummary, errorTableHeader);
                }
        }

        /**
         * Build the footer of the summary.
         */
        public void buildPackageFooter(XMLNode node) {
                packageWriter.writePackageFooter();
        }
}