src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/PackageSummaryBuilder.java

changeset 243
edd944553131
parent 184
905e151a185a
child 554
9d9f26857129
equal deleted inserted replaced
242:889ec3ddc91b 243:edd944553131
38 * This code is not part of an API. 38 * This code is not part of an API.
39 * It is implementation that is subject to change. 39 * It is implementation that is subject to change.
40 * Do not use it as an API 40 * Do not use it as an API
41 * 41 *
42 * @author Jamie Ho 42 * @author Jamie Ho
43 * @author Bhavesh Patel (Modified)
43 * @since 1.5 44 * @since 1.5
44 */ 45 */
45 public class PackageSummaryBuilder extends AbstractBuilder { 46 public class PackageSummaryBuilder extends AbstractBuilder {
46 47
47 /** 48 /**
182 183
183 /** 184 /**
184 * Build the summary for the classes in this package. 185 * Build the summary for the classes in this package.
185 */ 186 */
186 public void buildClassSummary() { 187 public void buildClassSummary() {
187 ClassDoc[] classes = 188 String classTableSummary =
189 configuration.getText("doclet.Member_Table_Summary",
190 configuration.getText("doclet.Class_Summary"),
191 configuration.getText("doclet.classes"));
192 String[] classTableHeader = new String[] {
193 configuration.getText("doclet.Class"),
194 configuration.getText("doclet.Description")
195 };
196 ClassDoc[] classes =
188 packageDoc.isIncluded() 197 packageDoc.isIncluded()
189 ? packageDoc.ordinaryClasses() 198 ? packageDoc.ordinaryClasses()
190 : configuration.classDocCatalog.ordinaryClasses( 199 : configuration.classDocCatalog.ordinaryClasses(
191 Util.getPackageName(packageDoc)); 200 Util.getPackageName(packageDoc));
192 if (classes.length > 0) { 201 if (classes.length > 0) {
193 packageWriter.writeClassesSummary( 202 packageWriter.writeClassesSummary(
194 classes, 203 classes,
195 configuration.getText("doclet.Class_Summary")); 204 configuration.getText("doclet.Class_Summary"),
205 classTableSummary, classTableHeader);
196 } 206 }
197 } 207 }
198 208
199 /** 209 /**
200 * Build the summary for the interfaces in this package. 210 * Build the summary for the interfaces in this package.
201 */ 211 */
202 public void buildInterfaceSummary() { 212 public void buildInterfaceSummary() {
203 ClassDoc[] interfaces = 213 String interfaceTableSummary =
214 configuration.getText("doclet.Member_Table_Summary",
215 configuration.getText("doclet.Interface_Summary"),
216 configuration.getText("doclet.interfaces"));
217 String[] interfaceTableHeader = new String[] {
218 configuration.getText("doclet.Interface"),
219 configuration.getText("doclet.Description")
220 };
221 ClassDoc[] interfaces =
204 packageDoc.isIncluded() 222 packageDoc.isIncluded()
205 ? packageDoc.interfaces() 223 ? packageDoc.interfaces()
206 : configuration.classDocCatalog.interfaces( 224 : configuration.classDocCatalog.interfaces(
207 Util.getPackageName(packageDoc)); 225 Util.getPackageName(packageDoc));
208 if (interfaces.length > 0) { 226 if (interfaces.length > 0) {
209 packageWriter.writeClassesSummary( 227 packageWriter.writeClassesSummary(
210 interfaces, 228 interfaces,
211 configuration.getText("doclet.Interface_Summary")); 229 configuration.getText("doclet.Interface_Summary"),
230 interfaceTableSummary, interfaceTableHeader);
212 } 231 }
213 } 232 }
214 233
215 /** 234 /**
216 * Build the summary for the enums in this package. 235 * Build the summary for the enums in this package.
217 */ 236 */
218 public void buildAnnotationTypeSummary() { 237 public void buildAnnotationTypeSummary() {
219 ClassDoc[] annotationTypes = 238 String annotationtypeTableSummary =
239 configuration.getText("doclet.Member_Table_Summary",
240 configuration.getText("doclet.Annotation_Types_Summary"),
241 configuration.getText("doclet.annotationtypes"));
242 String[] annotationtypeTableHeader = new String[] {
243 configuration.getText("doclet.AnnotationType"),
244 configuration.getText("doclet.Description")
245 };
246 ClassDoc[] annotationTypes =
220 packageDoc.isIncluded() 247 packageDoc.isIncluded()
221 ? packageDoc.annotationTypes() 248 ? packageDoc.annotationTypes()
222 : configuration.classDocCatalog.annotationTypes( 249 : configuration.classDocCatalog.annotationTypes(
223 Util.getPackageName(packageDoc)); 250 Util.getPackageName(packageDoc));
224 if (annotationTypes.length > 0) { 251 if (annotationTypes.length > 0) {
225 packageWriter.writeClassesSummary( 252 packageWriter.writeClassesSummary(
226 annotationTypes, 253 annotationTypes,
227 configuration.getText("doclet.Annotation_Types_Summary")); 254 configuration.getText("doclet.Annotation_Types_Summary"),
255 annotationtypeTableSummary, annotationtypeTableHeader);
228 } 256 }
229 } 257 }
230 258
231 /** 259 /**
232 * Build the summary for the enums in this package. 260 * Build the summary for the enums in this package.
233 */ 261 */
234 public void buildEnumSummary() { 262 public void buildEnumSummary() {
235 ClassDoc[] enums = 263 String enumTableSummary =
264 configuration.getText("doclet.Member_Table_Summary",
265 configuration.getText("doclet.Enum_Summary"),
266 configuration.getText("doclet.enums"));
267 String[] enumTableHeader = new String[] {
268 configuration.getText("doclet.Enum"),
269 configuration.getText("doclet.Description")
270 };
271 ClassDoc[] enums =
236 packageDoc.isIncluded() 272 packageDoc.isIncluded()
237 ? packageDoc.enums() 273 ? packageDoc.enums()
238 : configuration.classDocCatalog.enums( 274 : configuration.classDocCatalog.enums(
239 Util.getPackageName(packageDoc)); 275 Util.getPackageName(packageDoc));
240 if (enums.length > 0) { 276 if (enums.length > 0) {
241 packageWriter.writeClassesSummary( 277 packageWriter.writeClassesSummary(
242 enums, 278 enums,
243 configuration.getText("doclet.Enum_Summary")); 279 configuration.getText("doclet.Enum_Summary"),
280 enumTableSummary, enumTableHeader);
244 } 281 }
245 } 282 }
246 283
247 /** 284 /**
248 * Build the summary for the exceptions in this package. 285 * Build the summary for the exceptions in this package.
249 */ 286 */
250 public void buildExceptionSummary() { 287 public void buildExceptionSummary() {
251 ClassDoc[] exceptions = 288 String exceptionTableSummary =
289 configuration.getText("doclet.Member_Table_Summary",
290 configuration.getText("doclet.Exception_Summary"),
291 configuration.getText("doclet.exceptions"));
292 String[] exceptionTableHeader = new String[] {
293 configuration.getText("doclet.Exception"),
294 configuration.getText("doclet.Description")
295 };
296 ClassDoc[] exceptions =
252 packageDoc.isIncluded() 297 packageDoc.isIncluded()
253 ? packageDoc.exceptions() 298 ? packageDoc.exceptions()
254 : configuration.classDocCatalog.exceptions( 299 : configuration.classDocCatalog.exceptions(
255 Util.getPackageName(packageDoc)); 300 Util.getPackageName(packageDoc));
256 if (exceptions.length > 0) { 301 if (exceptions.length > 0) {
257 packageWriter.writeClassesSummary( 302 packageWriter.writeClassesSummary(
258 exceptions, 303 exceptions,
259 configuration.getText("doclet.Exception_Summary")); 304 configuration.getText("doclet.Exception_Summary"),
305 exceptionTableSummary, exceptionTableHeader);
260 } 306 }
261 } 307 }
262 308
263 /** 309 /**
264 * Build the summary for the errors in this package. 310 * Build the summary for the errors in this package.
265 */ 311 */
266 public void buildErrorSummary() { 312 public void buildErrorSummary() {
267 ClassDoc[] errors = 313 String errorTableSummary =
314 configuration.getText("doclet.Member_Table_Summary",
315 configuration.getText("doclet.Error_Summary"),
316 configuration.getText("doclet.errors"));
317 String[] errorTableHeader = new String[] {
318 configuration.getText("doclet.Error"),
319 configuration.getText("doclet.Description")
320 };
321 ClassDoc[] errors =
268 packageDoc.isIncluded() 322 packageDoc.isIncluded()
269 ? packageDoc.errors() 323 ? packageDoc.errors()
270 : configuration.classDocCatalog.errors( 324 : configuration.classDocCatalog.errors(
271 Util.getPackageName(packageDoc)); 325 Util.getPackageName(packageDoc));
272 if (errors.length > 0) { 326 if (errors.length > 0) {
273 packageWriter.writeClassesSummary( 327 packageWriter.writeClassesSummary(
274 errors, 328 errors,
275 configuration.getText("doclet.Error_Summary")); 329 configuration.getText("doclet.Error_Summary"),
330 errorTableSummary, errorTableHeader);
276 } 331 }
277 } 332 }
278 333
279 /** 334 /**
280 * Build the footer of the summary. 335 * Build the footer of the summary.

mercurial