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

6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell

     1 /*

     2  * Copyright 2003-2008 Sun Microsystems, Inc.  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.  Sun designates this

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

     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    22  * CA 95054 USA or visit www.sun.com if you need additional information or

    23  * have any questions.

    24  */

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

    28 import com.sun.javadoc.*;

    29 import java.util.*;

    30 import java.io.*;

    32 /**

    33  * The interface for writing constants 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  * @since 1.5

    41  */

    43 public interface ConstantsSummaryWriter {

    45     /**

    46      * Write the header for the summary.

    47      */

    48     public abstract void writeHeader();

    50     /**

    51      * Write the footer for the summary.

    52      */

    53     public abstract void writeFooter();

    55     /**

    56      * Close the writer.

    57      */

    58     public abstract void close() throws IOException;

    60     /**

    61      * Write the header for the index.

    62      */

    63     public abstract void writeContentsHeader();

    65     /**

    66      * Write the footer for the index.

    67      */

    68     public abstract void writeContentsFooter();

    70     /**

    71      * Add the given package name to the index.

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

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

    74      *                               first 2 directory levels of the package

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

    76      *                               indexed as java.lang.*.

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

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

    79      *                              something more than once.

    80      */

    81     public abstract void writeLinkToPackageContent(PackageDoc pkg, String parsedPackageName,

    82         Set<String> WriteedPackageHeaders);

    84     /**

    85      * Write the given package name.

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

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

    88      *                               first 2 directory levels of the package

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

    90      *                               indexed as java.lang.*.

    91      */

    92     public abstract void writePackageName(PackageDoc pkg,

    93         String parsedPackageName);

    95     /**

    96      * Write the heading for the current table of constants for a given class.

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

    98      */

    99     public abstract void writeConstantMembersHeader(ClassDoc cd);

   101     /**

   102      * Document the given constants.

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

   104      * @param fields the constants being documented.

   105      */

   106     public abstract void writeConstantMembers(ClassDoc cd, List fields);

   108     /**

   109      * Document the given constants.

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

   111      */

   112     public abstract void writeConstantMembersFooter(ClassDoc cd);

   114 }

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