| /* |
| * Copyright (c) 2003, 2010, 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; |
| |
| 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 |
| * @author Bhavesh Patel (Modified) |
| * @since 1.5 |
| */ |
| |
| public interface PackageSummaryWriter { |
| |
| /** |
| * Return the name of the output file. |
| * |
| * @return the name of the output file. |
| */ |
| public abstract String getOutputFileName(); |
| |
| /** |
| * Get the header for the summary. |
| * |
| * @param heading Package name. |
| * @return the header to be added to the content tree |
| */ |
| public abstract Content getPackageHeader(String heading); |
| |
| /** |
| * Get the header for the package content. |
| * |
| * @return a content tree for the package content header |
| */ |
| public abstract Content getContentHeader(); |
| |
| /** |
| * Get the header for the package summary. |
| * |
| * @return a content tree with the package summary header |
| */ |
| public abstract Content getSummaryHeader(); |
| |
| /** |
| * Adds the table of classes to the documentation tree. |
| * |
| * @param classes the array of classes to document. |
| * @param label the label for this table. |
| * @param tableSummary the summary string for the table |
| * @param tableHeader array of table headers |
| * @param summaryContentTree the content tree to which the summaries will be added |
| */ |
| public abstract void addClassesSummary(ClassDoc[] classes, String label, |
| String tableSummary, String[] tableHeader, Content summaryContentTree); |
| |
| /** |
| * Adds the package description from the "packages.html" file to the documentation |
| * tree. |
| * |
| * @param packageContentTree the content tree to which the package description |
| * will be added |
| */ |
| public abstract void addPackageDescription(Content packageContentTree); |
| |
| /** |
| * Adds the tag information from the "packages.html" file to the documentation |
| * tree. |
| * |
| * @param packageContentTree the content tree to which the package tags will |
| * be added |
| */ |
| public abstract void addPackageTags(Content packageContentTree); |
| |
| /** |
| * Adds the footer to the documentation tree. |
| * |
| * @param contentTree the tree to which the footer will be added |
| */ |
| public abstract void addPackageFooter(Content contentTree); |
| |
| /** |
| * Print the package summary document. |
| * |
| * @param contentTree the content tree that will be printed |
| */ |
| public abstract void printDocument(Content contentTree); |
| |
| /** |
| * Close the writer. |
| */ |
| public abstract void close() throws IOException; |
| |
| } |