/*

 * 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

 * particular file as subject to the "Classpath" exception as provided

 *

 * 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.

 *

 */

package com.sun.tools.doclets.internal.toolkit;

import com.sun.javadoc.*;

import java.io.*;

/**

 * The interface for writing package summary output.

 *

 * 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

 * @since 1.5

 */

public interface PackageSummaryWriter {

    /**

     * Return the name of the output file.

     *

     * @return the name of the output file.

     */

    public abstract String getOutputFileName();

    /**

     * Write the header for the package summary.

     */

    public abstract void writeSummaryHeader();

    /**

     * Write the footer for the package summary.

     */

    public abstract void writeSummaryFooter();

    /**

     * Write the table of classes in this package.

     *

     * @param classes the array of classes to document.

     * @param label the label for this table.

     */

    public abstract void writeClassesSummary(ClassDoc[] classes, String label, String tableSummary, String[] tableHeader);

    /**

     * Write the header for the summary.

     *

     * @param heading Package name.

     */

    public abstract void writePackageHeader(String heading);

    /**

     * Print the package description from the "packages.html" file.

     */

    public abstract void writePackageDescription();

    /**

     * Print the tag information from the "packages.html" file.

     */

    public abstract void writePackageTags();

    /**

     * Write the footer for the summary.

     *

     */

    public abstract void writePackageFooter();

    /**

     * Close the writer.

     */

    public abstract void close() throws IOException;

}