01: /*
02: * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * 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: */
25:
26: package com.sun.tools.doclets.internal.toolkit;
27:
28: import java.io.*;
29: import com.sun.javadoc.*;
30:
31: /**
32: * The interface for writing annotation type 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: */
41:
42: public interface AnnotationTypeWriter {
43:
44: /**
45: * Write the header of the page.
46: * @param header the header to write.
47: */
48: public void writeHeader(String header);
49:
50: /**
51: * Write the signature of the current annotation type.
52: *
53: * @param modifiers the modifiers for the signature.
54: */
55: public void writeAnnotationTypeSignature(String modifiers);
56:
57: /**
58: * Build the annotation type description.
59: */
60: public void writeAnnotationTypeDescription();
61:
62: /**
63: * Write the tag information for the current annotation type.
64: */
65: public void writeAnnotationTypeTagInfo();
66:
67: /**
68: * If this annotation type is deprecated, write the appropriate information.
69: */
70: public void writeAnnotationTypeDeprecationInfo();
71:
72: /**
73: * Write the footer of the page.
74: */
75: public void writeFooter();
76:
77: /**
78: * Close the writer.
79: */
80: public void close() throws IOException;
81:
82: /**
83: * Return the {@link AnnotationTypeDoc} being documented.
84: *
85: * @return the AnnotationTypeDoc being documented.
86: */
87: public AnnotationTypeDoc getAnnotationTypeDoc();
88:
89: /**
90: * Perform any operations that are necessary when the member summary
91: * finished building.
92: */
93: public void completeMemberSummaryBuild();
94: }
|