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

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeWriter.java	Sat Dec 01 00:00:00 2007 +0000
     1.3 @@ -0,0 +1,95 @@
     1.4 +/*
     1.5 + * Copyright 2003 Sun Microsystems, Inc.  All Rights Reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Sun designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Sun in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or
    1.26 + * have any questions.
    1.27 + */
    1.28 +
    1.29 +
    1.30 +package com.sun.tools.doclets.internal.toolkit;
    1.31 +
    1.32 +import java.io.*;
    1.33 +import com.sun.javadoc.*;
    1.34 +
    1.35 +/**
    1.36 + * The interface for writing annotation type output.
    1.37 + *
    1.38 + * This code is not part of an API.
    1.39 + * It is implementation that is subject to change.
    1.40 + * Do not use it as an API.
    1.41 + *
    1.42 + * @author Jamie Ho
    1.43 + * @since 1.5
    1.44 + */
    1.45 +
    1.46 +public interface AnnotationTypeWriter {
    1.47 +
    1.48 +    /**
    1.49 +     * Write the header of the page.
    1.50 +     * @param header the header to write.
    1.51 +     */
    1.52 +    public void writeHeader(String header);
    1.53 +
    1.54 +    /**
    1.55 +     * Write the signature of the current annotation type.
    1.56 +     *
    1.57 +     * @param modifiers the modifiers for the signature.
    1.58 +     */
    1.59 +    public void writeAnnotationTypeSignature(String modifiers);
    1.60 +
    1.61 +    /**
    1.62 +     * Build the annotation type description.
    1.63 +     */
    1.64 +    public void writeAnnotationTypeDescription();
    1.65 +
    1.66 +    /**
    1.67 +     * Write the tag information for the current annotation type.
    1.68 +     */
    1.69 +    public void writeAnnotationTypeTagInfo();
    1.70 +
    1.71 +    /**
    1.72 +     * If this annotation type is deprecated, write the appropriate information.
    1.73 +     */
    1.74 +    public void writeAnnotationTypeDeprecationInfo();
    1.75 +
    1.76 +    /**
    1.77 +     * Write the footer of the page.
    1.78 +     */
    1.79 +    public void writeFooter();
    1.80 +
    1.81 +    /**
    1.82 +     * Close the writer.
    1.83 +     */
    1.84 +    public void close() throws IOException;
    1.85 +
    1.86 +    /**
    1.87 +     * Return the {@link AnnotationTypeDoc} being documented.
    1.88 +     *
    1.89 +     * @return the AnnotationTypeDoc being documented.
    1.90 +     */
    1.91 +    public AnnotationTypeDoc getAnnotationTypeDoc();
    1.92 +
    1.93 +    /**
    1.94 +     * Perform any operations that are necessary when the member summary
    1.95 +     * finished building.
    1.96 +     */
    1.97 +    public void completeMemberSummaryBuild();
    1.98 +}