jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/NestedClassWriter.java@9a66ca7c79fa

     1 /*

     2  * Copyright 2003 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 java.io.*;

    29 import com.sun.javadoc.*;

    31 /**

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

    40  */

    42 public interface NestedClassWriter {

    44     /**

    45      * Write the classes summary header for the given class.

    46      *

    47      * @param nestedClass the class the summary belongs to.

    48      */

    49     public void writeNestedClassSummaryHeader(ClassDoc nestedClass);

    51     /**

    52      * Write the class summary for the given class and class.

    53      *

    54      * @param classDoc the class the summary belongs to.

    55      * @param nestedClass the nested class that I am summarizing.

    56      */

    57     public void writeNestedClassSummary(ClassDoc classDoc, ClassDoc nestedClass);

    59     /**

    60      * Write the classes summary footer for the given class.

    61      *

    62      * @param nestedClass the class the summary belongs to.

    63      */

    64     public void writeNestedClassSummaryFooter(ClassDoc nestedClass);

    66     /**

    67      * Write the inherited classes summary header for the given class.

    68      *

    69      * @param nestedClass the class the summary belongs to.

    70      */

    71     public void writeInheritedNestedClassSummaryHeader(ClassDoc nestedClass);

    73     /**

    74      * Write the inherited nested class summary for the given class and nested

    75      * class.

    76      *

    77      * @param classDoc the class the inherited nested class belongs to.

    78      * @param nestedClass the inherited nested class that I am summarizing.

    79      * @param isFirst true if this is the first member in the list.

    80      */

    81     public void writeInheritedNestedClassSummary(ClassDoc classDoc,

    82             ClassDoc nestedClass, boolean isFirst);

    84     /**

    85      * Write the inherited classes summary footer for the given class.

    86      *

    87      * @param nestedClass the class the summary belongs to.

    88      */

    89     public void writeInheritedNestedClassSummaryFooter(ClassDoc nestedClass);

    91     /**

    92      * Close the writer.

    93      */

    94     public void close() throws IOException;

    95 }

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