jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/ClassWriter.java@4177f5bdd189

     1 /*

     2  * Copyright (c) 2003, 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  */

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

    29 import java.io.*;

    30 import com.sun.javadoc.*;

    32 /**

    33  * The interface for writing class 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 ClassWriter {

    45     /**

    46      * Write the header of the page.

    47      * @param header the header to write.

    48      */

    49     public void writeHeader(String header);

    51     /**

    52      * Write the class tree documentation.

    53      */

    54     public void writeClassTree();

    56     /**

    57      * Write all implemented interfaces if this is a class.

    58      */

    59     public void writeImplementedInterfacesInfo();

    61     /**

    62      * Write all super interfaces if this is an interface.

    63      */

    64     public void writeSuperInterfacesInfo();

    66     /**

    67      * Write the type parameter information.

    68      */

    69     public void writeTypeParamInfo();

    71     /**

    72      * Write all the classes that extend this one.

    73      */

    74     public void writeSubClassInfo();

    76     /**

    77      * Write all the interfaces that extend this one.

    78      */

    79     public void writeSubInterfacesInfo();

    81     /**

    82      * If this is an interface, write all classes that implement this

    83      * interface.

    84      */

    85     public void writeInterfaceUsageInfo ();

    87     /**

    88      * If this is an inner class or interface, write the enclosing class or

    89      * interface.

    90      */

    91     public void writeNestedClassInfo ();

    93     /**

    94      * If this class is deprecated, write the appropriate information.

    95      */

    96     public void writeClassDeprecationInfo ();

    98     /**

    99      * Write the signature of the current class.

   100      *

   101      * @param modifiers the modifiers for the signature.

   102      */

   103     public void writeClassSignature(String modifiers);

   105     /**

   106      * Build the class description.

   107      */

   108     public void writeClassDescription();

   110     /**

   111      * Write the tag information for the current class.

   112      */

   113     public void writeClassTagInfo();

   115     /**

   116      * Write the footer of the page.

   117      */

   118     public void writeFooter();

   120     /**

   121      * Close the writer.

   122      */

   123     public void close() throws IOException;

   125     /**

   126      * Return the classDoc being documented.

   127      *

   128      * @return the classDoc being documented.

   129      */

   130     public ClassDoc getClassDoc();

   132     /**

   133      * Perform any operations that are necessary when the member summary

   134      * finished building.

   135      */

   136     public void completeMemberSummaryBuild();

   137 }

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