jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/PackageSummaryWriter.java@c75be5bc5283

     1 /*

     2  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

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

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

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

    28 import java.io.*;

    30 import com.sun.javadoc.*;

    32 /**

    33  * The interface for writing package summary output.

    34  *

    35  * This code is not part of an API.

    36  * It is implementation that is subject to change.

    37  * Do not use it as an API

    38  *

    39  * @author Jamie Ho

    40  * @author Bhavesh Patel (Modified)

    41  * @since 1.5

    42  */

    44 public interface PackageSummaryWriter {

    46     /**

    47      * Return the name of the output file.

    48      *

    49      * @return the name of the output file.

    50      */

    51     public abstract String getOutputFileName();

    53     /**

    54      * Get the header for the summary.

    55      *

    56      * @param heading Package name.

    57      * @return the header to be added to the content tree

    58      */

    59     public abstract Content getPackageHeader(String heading);

    61     /**

    62      * Get the header for the package content.

    63      *

    64      * @return a content tree for the package content header

    65      */

    66     public abstract Content getContentHeader();

    68     /**

    69      * Get the header for the package summary.

    70      *

    71      * @return a content tree with the package summary header

    72      */

    73     public abstract Content getSummaryHeader();

    75     /**

    76      * Adds the table of classes to the documentation tree.

    77      *

    78      * @param classes the array of classes to document.

    79      * @param label the label for this table.

    80      * @param tableSummary the summary string for the table

    81      * @param tableHeader array of table headers

    82      * @param summaryContentTree the content tree to which the summaries will be added

    83      */

    84     public abstract void addClassesSummary(ClassDoc[] classes, String label,

    85             String tableSummary, String[] tableHeader, Content summaryContentTree);

    87     /**

    88      * Adds the package description from the "packages.html" file to the documentation

    89      * tree.

    90      *

    91      * @param packageContentTree the content tree to which the package description

    92      *                           will be added

    93      */

    94     public abstract void addPackageDescription(Content packageContentTree);

    96     /**

    97      * Adds the tag information from the "packages.html" file to the documentation

    98      * tree.

    99      *

   100      * @param packageContentTree the content tree to which the package tags will

   101      *                           be added

   102      */

   103     public abstract void addPackageTags(Content packageContentTree);

   105     /**

   106      * Adds the footer to the documentation tree.

   107      *

   108      * @param contentTree the tree to which the footer will be added

   109      */

   110     public abstract void addPackageFooter(Content contentTree);

   112     /**

   113      * Print the package summary document.

   114      *

   115      * @param contentTree the content tree that will be printed

   116      */

   117     public abstract void printDocument(Content contentTree);

   119     /**

   120      * Close the writer.

   121      */

   122     public abstract void close() throws IOException;

   124 }

Mercurial > jdk8-mips64-public > langtools / file revision