jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/ProfilePackageSummaryWriter.java@5f0731e4e5e6

     1 /*

     2  * Copyright (c) 2013, 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 profile package summary output.

    34  *

    35  *  <p><b>This is NOT part of any supported API.

    36  *  If you write code that depends on this, you do so at your own risk.

    37  *  This code and its internal interfaces are subject to change or

    38  *  deletion without notice.</b>

    39  *

    40  * @author Bhavesh Patel

    41  */

    43 public interface ProfilePackageSummaryWriter {

    45     /**

    46      * Get the header for the summary.

    47      *

    48      * @param heading Package name.

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

    50      */

    51     public abstract Content getPackageHeader(String heading);

    53     /**

    54      * Get the header for the content.

    55      *

    56      * @return a content tree for the content header

    57      */

    58     public abstract Content getContentHeader();

    60     /**

    61      * Get the header for the package summary.

    62      *

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

    64      */

    65     public abstract Content getSummaryHeader();

    67     /**

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

    69      *

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

    71      * @param label the label for this table.

    72      * @param tableSummary the summary string for the table

    73      * @param tableHeader array of table headers

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

    75      */

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

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

    79     /**

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

    81      * tree.

    82      *

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

    84      *                           will be added

    85      */

    86     public abstract void addPackageDescription(Content packageContentTree);

    88     /**

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

    90      * tree.

    91      *

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

    93      *                           be added

    94      */

    95     public abstract void addPackageTags(Content packageContentTree);

    97     /**

    98      * Adds the footer to the documentation tree.

    99      *

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

   101      */

   102     public abstract void addPackageFooter(Content contentTree);

   104     /**

   105      * Print the package summary document.

   106      *

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

   108      */

   109     public abstract void printDocument(Content contentTree) throws IOException;

   111     /**

   112      * Close the writer.

   113      */

   114     public abstract void close() throws IOException;

   116 }

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