jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeWriter.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  */

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

    29 import java.io.*;

    30 import com.sun.javadoc.*;

    32 /**

    33  * The interface for writing annotation type 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 AnnotationTypeWriter {

    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 signature of the current annotation type.

    53      *

    54      * @param modifiers the modifiers for the signature.

    55      */

    56     public void writeAnnotationTypeSignature(String modifiers);

    58     /**

    59      * Build the annotation type description.

    60      */

    61     public void writeAnnotationTypeDescription();

    63     /**

    64      * Write the tag information for the current annotation type.

    65      */

    66     public void writeAnnotationTypeTagInfo();

    68     /**

    69      * If this annotation type is deprecated, write the appropriate information.

    70      */

    71     public void writeAnnotationTypeDeprecationInfo();

    73     /**

    74      * Write the footer of the page.

    75      */

    76     public void writeFooter();

    78     /**

    79      * Close the writer.

    80      */

    81     public void close() throws IOException;

    83     /**

    84      * Return the {@link AnnotationTypeDoc} being documented.

    85      *

    86      * @return the AnnotationTypeDoc being documented.

    87      */

    88     public AnnotationTypeDoc getAnnotationTypeDoc();

    90     /**

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

    92      * finished building.

    93      */

    94     public void completeMemberSummaryBuild();

    95 }

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