Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/PackageSummaryWriter.java@4177f5bdd189 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/PackageSummaryWriter.java
Fri, 18 Jun 2010 21:13:56 -0700
- author
- jjg
- date
- Fri, 18 Jun 2010 21:13:56 -0700
- changeset 589
- 4177f5bdd189
- parent 554
- 9d9f26857129
- child 766
- 90af8d87741f
- permissions
- -rw-r--r--
6961178: Allow doclet.xml to contain XML attributes
Reviewed-by: bpatel
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit; |
| duke@1 | 27 | |
| duke@1 | 28 | import com.sun.javadoc.*; |
| duke@1 | 29 | import java.io.*; |
| duke@1 | 30 | |
| duke@1 | 31 | /** |
| duke@1 | 32 | * The interface for writing package summary output. |
| duke@1 | 33 | * |
| duke@1 | 34 | * This code is not part of an API. |
| duke@1 | 35 | * It is implementation that is subject to change. |
| duke@1 | 36 | * Do not use it as an API |
| duke@1 | 37 | * |
| duke@1 | 38 | * @author Jamie Ho |
| duke@1 | 39 | * @since 1.5 |
| duke@1 | 40 | */ |
| duke@1 | 41 | |
| duke@1 | 42 | public interface PackageSummaryWriter { |
| duke@1 | 43 | |
| duke@1 | 44 | /** |
| duke@1 | 45 | * Return the name of the output file. |
| duke@1 | 46 | * |
| duke@1 | 47 | * @return the name of the output file. |
| duke@1 | 48 | */ |
| duke@1 | 49 | public abstract String getOutputFileName(); |
| duke@1 | 50 | |
| duke@1 | 51 | /** |
| duke@1 | 52 | * Write the header for the package summary. |
| duke@1 | 53 | */ |
| duke@1 | 54 | public abstract void writeSummaryHeader(); |
| duke@1 | 55 | |
| duke@1 | 56 | /** |
| duke@1 | 57 | * Write the footer for the package summary. |
| duke@1 | 58 | */ |
| duke@1 | 59 | public abstract void writeSummaryFooter(); |
| duke@1 | 60 | |
| duke@1 | 61 | /** |
| duke@1 | 62 | * Write the table of classes in this package. |
| duke@1 | 63 | * |
| duke@1 | 64 | * @param classes the array of classes to document. |
| duke@1 | 65 | * @param label the label for this table. |
| duke@1 | 66 | */ |
| bpatel@243 | 67 | public abstract void writeClassesSummary(ClassDoc[] classes, String label, String tableSummary, String[] tableHeader); |
| duke@1 | 68 | |
| duke@1 | 69 | /** |
| duke@1 | 70 | * Write the header for the summary. |
| duke@1 | 71 | * |
| duke@1 | 72 | * @param heading Package name. |
| duke@1 | 73 | */ |
| duke@1 | 74 | public abstract void writePackageHeader(String heading); |
| duke@1 | 75 | |
| duke@1 | 76 | /** |
| duke@1 | 77 | * Print the package description from the "packages.html" file. |
| duke@1 | 78 | */ |
| duke@1 | 79 | public abstract void writePackageDescription(); |
| duke@1 | 80 | |
| duke@1 | 81 | /** |
| duke@1 | 82 | * Print the tag information from the "packages.html" file. |
| duke@1 | 83 | */ |
| duke@1 | 84 | public abstract void writePackageTags(); |
| duke@1 | 85 | |
| duke@1 | 86 | /** |
| duke@1 | 87 | * Write the footer for the summary. |
| duke@1 | 88 | * |
| duke@1 | 89 | */ |
| duke@1 | 90 | public abstract void writePackageFooter(); |
| duke@1 | 91 | |
| duke@1 | 92 | /** |
| duke@1 | 93 | * Close the writer. |
| duke@1 | 94 | */ |
| duke@1 | 95 | public abstract void close() throws IOException; |
| duke@1 | 96 | |
| duke@1 | 97 | } |
