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

7032975: API files in javax.annotation.processing need to be updated for references to JLS
7032972: API files in javax.tools need to updated for references to JVM Spec with editions/hyperlinks
7032978: API files in javax.tools need to be updated for references to JLS with editions/hyperlinks
Summary: Removed URLs and 'edition' references
Reviewed-by: jjg, darcy

     1 /*

     2  * Copyright (c) 2003, 2010, 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 com.sun.javadoc.*;

    29 import java.io.*;

    31 /**

    32  * The interface for writing package summary output.

    33  *

    34  * This code is not part of an API.

    35  * It is implementation that is subject to change.

    36  * Do not use it as an API

    37  *

    38  * @author Jamie Ho

    39  * @author Bhavesh Patel (Modified)

    40  * @since 1.5

    41  */

    43 public interface PackageSummaryWriter {

    45     /**

    46      * Return the name of the output file.

    47      *

    48      * @return the name of the output file.

    49      */

    50     public abstract String getOutputFileName();

    52     /**

    53      * Get the header for the summary.

    54      *

    55      * @param heading Package name.

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

    57      */

    58     public abstract Content getPackageHeader(String heading);

    60     /**

    61      * Get the header for the package content.

    62      *

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

    64      */

    65     public abstract Content getContentHeader();

    67     /**

    68      * Get the header for the package summary.

    69      *

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

    71      */

    72     public abstract Content getSummaryHeader();

    74     /**

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

    76      *

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

    78      * @param label the label for this table.

    79      * @param tableSummary the summary string for the table

    80      * @param tableHeader array of table headers

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

    82      */

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

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

    86     /**

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

    88      * tree.

    89      *

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

    91      *                           will be added

    92      */

    93     public abstract void addPackageDescription(Content packageContentTree);

    95     /**

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

    97      * tree.

    98      *

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

   100      *                           be added

   101      */

   102     public abstract void addPackageTags(Content packageContentTree);

   104     /**

   105      * Adds the footer to the documentation tree.

   106      *

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

   108      */

   109     public abstract void addPackageFooter(Content contentTree);

   111     /**

   112      * Print the package summary document.

   113      *

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

   115      */

   116     public abstract void printDocument(Content contentTree);

   118     /**

   119      * Close the writer.

   120      */

   121     public abstract void close() throws IOException;

   123 }

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

src/share/classes/com/sun/tools/doclets/internal/toolkit/PackageSummaryWriter.java@694ff82ca68e

src/share/classes/com/sun/tools/doclets/internal/toolkit/PackageSummaryWriter.java