Mercurial > jdk8-mips64-public > langtools / file revision
src/share/classes/com/sun/tools/doclets/internal/toolkit/ClassWriter.java@5f0731e4e5e6
src/share/classes/com/sun/tools/doclets/internal/toolkit/ClassWriter.java
Mon, 21 Jan 2013 00:45:35 -0500
- author
- bpatel
- date
- Mon, 21 Jan 2013 00:45:35 -0500
- changeset 1568
- 5f0731e4e5e6
- parent 1468
- 690c41cdab55
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8006124: javadoc/doclet should be updated to support profiles
Reviewed-by: jjg
1 /*
2 * Copyright (c) 2003, 2012, 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 * <p><b>This is NOT part of any supported API.
36 * If you write code that depends on this, you do so at your own risk.
37 * This code and its internal interfaces are subject to change or
38 * deletion without notice.</b>
39 *
40 * @author Jamie Ho
41 * @author Bhavesh Patel (Modified)
42 * @since 1.5
43 */
45 public interface ClassWriter {
47 /**
48 * Get the header of the page.
49 *
50 * @param header the header string to write
51 * @return header content that needs to be added to the documentation
52 */
53 public Content getHeader(String header);
55 /**
56 * Get the class content header.
57 *
58 * @return class content header that needs to be added to the documentation
59 */
60 public Content getClassContentHeader();
62 /**
63 * Add the class tree documentation.
64 *
65 * @param classContentTree class content tree to which the documentation will be added
66 */
67 public void addClassTree(Content classContentTree);
69 /**
70 * Get the class information tree header.
71 *
72 * @return class informaion tree header that needs to be added to the documentation
73 */
74 public Content getClassInfoTreeHeader();
76 /**
77 * Add the type parameter information.
78 *
79 * @param classInfoTree content tree to which the documentation will be added
80 */
81 public void addTypeParamInfo(Content classInfoTree);
83 /**
84 * Add all super interfaces if this is an interface.
85 *
86 * @param classInfoTree content tree to which the documentation will be added
87 */
88 public void addSuperInterfacesInfo(Content classInfoTree);
90 /**
91 * Add all implemented interfaces if this is a class.
92 *
93 * @param classInfoTree content tree to which the documentation will be added
94 */
95 public void addImplementedInterfacesInfo(Content classInfoTree);
97 /**
98 * Add all the classes that extend this one.
99 *
100 * @param classInfoTree content tree to which the documentation will be added
101 */
102 public void addSubClassInfo(Content classInfoTree);
104 /**
105 * Add all the interfaces that extend this one.
106 *
107 * @param classInfoTree content tree to which the documentation will be added
108 */
109 public void addSubInterfacesInfo(Content classInfoTree);
111 /**
112 * If this is an interface, add all classes that implement this
113 * interface.
114 *
115 * @param classInfoTree content tree to which the documentation will be added
116 */
117 public void addInterfaceUsageInfo(Content classInfoTree);
119 /**
120 * If this is an functional interface, display appropriate message.
121 *
122 * @param classInfoTree content tree to which the documentation will be added
123 */
124 public void addFunctionalInterfaceInfo(Content classInfoTree);
126 /**
127 * If this is an inner class or interface, add the enclosing class or
128 * interface.
129 *
130 * @param classInfoTree content tree to which the documentation will be added
131 */
132 public void addNestedClassInfo (Content classInfoTree);
134 /**
135 * Get the class information.
136 *
137 * @param classInfoTree content tree conatining the class information
138 * @return a content tree for the class
139 */
140 public Content getClassInfo(Content classInfoTree);
142 /**
143 * If this class is deprecated, add the appropriate information.
144 *
145 * @param classInfoTree content tree to which the documentation will be added
146 */
147 public void addClassDeprecationInfo (Content classInfoTree);
149 /**
150 * Add the signature of the current class content tree.
151 *
152 * @param modifiers the modifiers for the signature
153 * @param classInfoTree the class content tree to which the signature will be added
154 */
155 public void addClassSignature(String modifiers, Content classInfoTree);
157 /**
158 * Build the class description.
159 *
160 * @param classInfoTree content tree to which the documentation will be added
161 */
162 public void addClassDescription(Content classInfoTree);
164 /**
165 * Add the tag information for the current class.
166 *
167 * @param classInfoTree content tree to which the tag information will be added
168 */
169 public void addClassTagInfo(Content classInfoTree);
171 /**
172 * Get the member tree header for the class.
173 *
174 * @return a content tree for the member tree header
175 */
176 public Content getMemberTreeHeader();
178 /**
179 * Add the footer of the page.
180 *
181 * @param contentTree content tree to which the footer will be added
182 */
183 public void addFooter(Content contentTree);
185 /**
186 * Print the document.
187 *
188 * @param contentTree content tree that will be printed as a document
189 */
190 public void printDocument(Content contentTree) throws IOException;
192 /**
193 * Close the writer.
194 */
195 public void close() throws IOException;
197 /**
198 * Return the classDoc being documented.
199 *
200 * @return the classDoc being documented.
201 */
202 public ClassDoc getClassDoc();
204 /**
205 * Get the member summary tree.
206 *
207 * @param memberTree the content tree used to build the summary tree
208 * @return a content tree for the member summary
209 */
210 public Content getMemberSummaryTree(Content memberTree);
212 /**
213 * Get the member details tree.
214 *
215 * @param memberTree the content tree used to build the details tree
216 * @return a content tree for the member details
217 */
218 public Content getMemberDetailsTree(Content memberTree);
219 }
