aoqi@0: /*
aoqi@0:  * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclets.internal.toolkit;
aoqi@0: 
aoqi@0: import java.io.*;
aoqi@0: 
aoqi@0: import com.sun.javadoc.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * The interface for writing profile package summary output.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Bhavesh Patel
aoqi@0:  */
aoqi@0: 
aoqi@0: public interface ProfilePackageSummaryWriter {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the header for the summary.
aoqi@0:      *
aoqi@0:      * @param heading Package name.
aoqi@0:      * @return the header to be added to the content tree
aoqi@0:      */
aoqi@0:     public abstract Content getPackageHeader(String heading);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the header for the content.
aoqi@0:      *
aoqi@0:      * @return a content tree for the content header
aoqi@0:      */
aoqi@0:     public abstract Content getContentHeader();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the header for the package summary.
aoqi@0:      *
aoqi@0:      * @return a content tree with the package summary header
aoqi@0:      */
aoqi@0:     public abstract Content getSummaryHeader();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Adds the table of classes to the documentation tree.
aoqi@0:      *
aoqi@0:      * @param classes the array of classes to document.
aoqi@0:      * @param label the label for this table.
aoqi@0:      * @param tableSummary the summary string for the table
aoqi@0:      * @param tableHeader array of table headers
aoqi@0:      * @param summaryContentTree the content tree to which the summaries will be added
aoqi@0:      */
aoqi@0:     public abstract void addClassesSummary(ClassDoc[] classes, String label,
aoqi@0:             String tableSummary, String[] tableHeader, Content summaryContentTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Adds the package description from the "packages.html" file to the documentation
aoqi@0:      * tree.
aoqi@0:      *
aoqi@0:      * @param packageContentTree the content tree to which the package description
aoqi@0:      *                           will be added
aoqi@0:      */
aoqi@0:     public abstract void addPackageDescription(Content packageContentTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Adds the tag information from the "packages.html" file to the documentation
aoqi@0:      * tree.
aoqi@0:      *
aoqi@0:      * @param packageContentTree the content tree to which the package tags will
aoqi@0:      *                           be added
aoqi@0:      */
aoqi@0:     public abstract void addPackageTags(Content packageContentTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Adds the footer to the documentation tree.
aoqi@0:      *
aoqi@0:      * @param contentTree the tree to which the footer will be added
aoqi@0:      */
aoqi@0:     public abstract void addPackageFooter(Content contentTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Print the package summary document.
aoqi@0:      *
aoqi@0:      * @param contentTree the content tree that will be printed
aoqi@0:      */
aoqi@0:     public abstract void printDocument(Content contentTree) throws IOException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Close the writer.
aoqi@0:      */
aoqi@0:     public abstract void close() throws IOException;
aoqi@0: 
aoqi@0: }