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;
duke@1: 
jjg@1357: import java.io.*;
jjg@1357: 
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: /**
duke@1:  * The interface for writing package summary output.
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: 
duke@1: public interface PackageSummaryWriter {
duke@1: 
duke@1:     /**
bpatel@766:      * Get the header for the summary.
bpatel@766:      *
bpatel@766:      * @param heading Package name.
bpatel@766:      * @return the header to be added to the content tree
duke@1:      */
bpatel@766:     public abstract Content getPackageHeader(String heading);
duke@1: 
duke@1:     /**
bpatel@766:      * Get the header for the package content.
bpatel@766:      *
bpatel@766:      * @return a content tree for the package content header
duke@1:      */
bpatel@766:     public abstract Content getContentHeader();
duke@1: 
duke@1:     /**
bpatel@766:      * Get the header for the package summary.
bpatel@766:      *
bpatel@766:      * @return a content tree with the package summary header
bpatel@766:      */
bpatel@766:     public abstract Content getSummaryHeader();
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Adds the table of classes to the documentation tree.
duke@1:      *
duke@1:      * @param classes the array of classes to document.
duke@1:      * @param label the label for this table.
bpatel@766:      * @param tableSummary the summary string for the table
bpatel@766:      * @param tableHeader array of table headers
bpatel@766:      * @param summaryContentTree the content tree to which the summaries will be added
duke@1:      */
bpatel@766:     public abstract void addClassesSummary(ClassDoc[] classes, String label,
bpatel@766:             String tableSummary, String[] tableHeader, Content summaryContentTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Adds the package description from the "packages.html" file to the documentation
bpatel@766:      * tree.
duke@1:      *
bpatel@766:      * @param packageContentTree the content tree to which the package description
bpatel@766:      *                           will be added
duke@1:      */
bpatel@766:     public abstract void addPackageDescription(Content packageContentTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Adds the tag information from the "packages.html" file to the documentation
bpatel@766:      * tree.
bpatel@766:      *
bpatel@766:      * @param packageContentTree the content tree to which the package tags will
bpatel@766:      *                           be added
duke@1:      */
bpatel@766:     public abstract void addPackageTags(Content packageContentTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Adds the footer to the documentation tree.
bpatel@766:      *
bpatel@766:      * @param contentTree the tree to which the footer will be added
duke@1:      */
bpatel@766:     public abstract void addPackageFooter(Content contentTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Print the package summary document.
duke@1:      *
bpatel@766:      * @param contentTree the content tree that will be printed
duke@1:      */
jjg@1364:     public abstract void printDocument(Content contentTree) throws IOException;
duke@1: 
duke@1:     /**
duke@1:      * Close the writer.
duke@1:      */
duke@1:     public abstract void close() throws IOException;
duke@1: 
duke@1: }