jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/ConstantsSummaryWriter.java@792c40d5185a

     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.*;

    29 import java.util.*;

    31 import com.sun.javadoc.*;

    33 /**

    34  * The interface for writing constants summary output.

    35  *

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

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

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

    39  *  deletion without notice.</b>

    40  *

    41  * @author Jamie Ho

    42  * @author Bhavesh Patel (Modified)

    43  * @since 1.5

    44  */

    46 public interface ConstantsSummaryWriter {

    48     /**

    49      * Close the writer.

    50      */

    51     public abstract void close() throws IOException;

    53     /**

    54      * Get the header for the constant summary documentation.

    55      *

    56      * @return header that needs to be added to the documentation

    57      */

    58     public abstract Content getHeader();

    60     /**

    61      * Get the header for the constant content list.

    62      *

    63      * @return content header that needs to be added to the documentation

    64      */

    65     public abstract Content getContentsHeader();

    67     /**

    68      * Adds the given package name link to the constant content list tree.

    69      *

    70      * @param pkg                    the {@link PackageDoc} to index.

    71      * @param parsedPackageName      the parsed package name.  We only Write the

    72      *                               first 2 directory levels of the package

    73      *                               name. For example, java.lang.ref would be

    74      *                               indexed as java.lang.*.

    75      * @param WriteedPackageHeaders the set of package headers that have already

    76      *                              been indexed.  We don't want to index

    77      *                              something more than once.

    78      * @param contentListTree the content tree to which the link will be added

    79      */

    80     public abstract void addLinkToPackageContent(PackageDoc pkg, String parsedPackageName,

    81         Set<String> WriteedPackageHeaders, Content contentListTree);

    83     /**

    84      * Get the content list to be added to the documentation tree.

    85      *

    86      * @param contentListTree the content that will be added to the list

    87      * @return content list that will be added to the documentation tree

    88      */

    89     public abstract Content getContentsList(Content contentListTree);

    91     /**

    92      * Get the constant summaries for the document.

    93      *

    94      * @return constant summaries header to be added to the documentation tree

    95      */

    96     public abstract Content getConstantSummaries();

    98     /**

    99      * Adds the given package name.

   100      *

   101      * @param pkg the {@link PackageDoc} to index.

   102      * @param parsedPackageName the parsed package name.  We only Write the

   103      *                          first 2 directory levels of the package

   104      *                          name. For example, java.lang.ref would be

   105      *                          indexed as java.lang.*.

   106      * @param summariesTree the documentation tree to which the package name will

   107      *                    be written

   108      */

   109     public abstract void addPackageName(PackageDoc pkg,

   110         String parsedPackageName, Content summariesTree);

   112     /**

   113      * Get the class summary header for the constants summary.

   114      *

   115      * @return the header content for the class constants summary

   116      */

   117     public abstract Content getClassConstantHeader();

   119     /**

   120      * Adds the constant member table to the documentation tree.

   121      *

   122      * @param cd the class whose constants are being documented.

   123      * @param fields the constants being documented.

   124      * @param classConstantTree the documentation tree to which theconstant member

   125      *                    table content will be added

   126      */

   127     public abstract void addConstantMembers(ClassDoc cd, List<FieldDoc> fields,

   128             Content classConstantTree);

   130     /**

   131      * Adds the footer for the summary documentation.

   132      *

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

   134      */

   135     public abstract void addFooter(Content contentTree);

   137     /**

   138      * Print the constants summary document.

   139      *

   140      * @param contentTree content tree which should be printed

   141      */

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

   144 }

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