001    /*
002     * Copyright 2003 Sun Microsystems, Inc.  All Rights Reserved.
003     * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004     *
005     * This code is free software; you can redistribute it and/or modify it
006     * under the terms of the GNU General Public License version 2 only, as
007     * published by the Free Software Foundation.  Sun designates this
008     * particular file as subject to the "Classpath" exception as provided
009     * by Sun in the LICENSE file that accompanied this code.
010     *
011     * This code is distributed in the hope that it will be useful, but WITHOUT
012     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013     * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014     * version 2 for more details (a copy is included in the LICENSE file that
015     * accompanied this code).
016     *
017     * You should have received a copy of the GNU General Public License version
018     * 2 along with this work; if not, write to the Free Software Foundation,
019     * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020     *
021     * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022     * CA 95054 USA or visit www.sun.com if you need additional information or
023     * have any questions.
024     */
025    
026    package com.sun.tools.doclets.internal.toolkit;
027    
028    import com.sun.javadoc.*;
029    import java.io.*;
030    
031    /**
032     * The interface for writing package summary output.
033     *
034     * This code is not part of an API.
035     * It is implementation that is subject to change.
036     * Do not use it as an API
037     *
038     * @author Jamie Ho
039     * @since 1.5
040     */
041    
042    public interface PackageSummaryWriter {
043    
044        /**
045         * Return the name of the output file.
046         *
047         * @return the name of the output file.
048         */
049        public abstract String getOutputFileName();
050    
051        /**
052         * Write the header for the package summary.
053         */
054        public abstract void writeSummaryHeader();
055    
056        /**
057         * Write the footer for the package summary.
058         */
059        public abstract void writeSummaryFooter();
060    
061        /**
062         * Write the table of classes in this package.
063         *
064         * @param classes the array of classes to document.
065         * @param label the label for this table.
066         */
067        public abstract void writeClassesSummary(ClassDoc[] classes, String label);
068    
069        /**
070         * Write the header for the summary.
071         *
072         * @param heading Package name.
073         */
074        public abstract void writePackageHeader(String heading);
075    
076        /**
077         * Print the package description from the "packages.html" file.
078         */
079        public abstract void writePackageDescription();
080    
081        /**
082         * Print the tag information from the "packages.html" file.
083         */
084        public abstract void writePackageTags();
085    
086        /**
087         * Write the footer for the summary.
088         *
089         */
090        public abstract void writePackageFooter();
091    
092        /**
093         * Close the writer.
094         */
095        public abstract void close() throws IOException;
096    
097    }