Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/ConstantsSummaryWriter.java@4177f5bdd189 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/ConstantsSummaryWriter.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, 2008, 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.util.*; |
| duke@1 | 30 | import java.io.*; |
| duke@1 | 31 | |
| duke@1 | 32 | /** |
| duke@1 | 33 | * The interface for writing constants summary output. |
| duke@1 | 34 | * |
| duke@1 | 35 | * This code is not part of an API. |
| duke@1 | 36 | * It is implementation that is subject to change. |
| duke@1 | 37 | * Do not use it as an API |
| duke@1 | 38 | * |
| duke@1 | 39 | * @author Jamie Ho |
| duke@1 | 40 | * @since 1.5 |
| duke@1 | 41 | */ |
| duke@1 | 42 | |
| duke@1 | 43 | public interface ConstantsSummaryWriter { |
| duke@1 | 44 | |
| duke@1 | 45 | /** |
| duke@1 | 46 | * Write the header for the summary. |
| duke@1 | 47 | */ |
| duke@1 | 48 | public abstract void writeHeader(); |
| duke@1 | 49 | |
| duke@1 | 50 | /** |
| duke@1 | 51 | * Write the footer for the summary. |
| duke@1 | 52 | */ |
| duke@1 | 53 | public abstract void writeFooter(); |
| duke@1 | 54 | |
| duke@1 | 55 | /** |
| duke@1 | 56 | * Close the writer. |
| duke@1 | 57 | */ |
| duke@1 | 58 | public abstract void close() throws IOException; |
| duke@1 | 59 | |
| duke@1 | 60 | /** |
| duke@1 | 61 | * Write the header for the index. |
| duke@1 | 62 | */ |
| duke@1 | 63 | public abstract void writeContentsHeader(); |
| duke@1 | 64 | |
| duke@1 | 65 | /** |
| duke@1 | 66 | * Write the footer for the index. |
| duke@1 | 67 | */ |
| duke@1 | 68 | public abstract void writeContentsFooter(); |
| duke@1 | 69 | |
| duke@1 | 70 | /** |
| duke@1 | 71 | * Add the given package name to the index. |
| duke@1 | 72 | * @param pkg the {@link PackageDoc} to index. |
| duke@1 | 73 | * @param parsedPackageName the parsed package name. We only Write the |
| duke@1 | 74 | * first 2 directory levels of the package |
| duke@1 | 75 | * name. For example, java.lang.ref would be |
| duke@1 | 76 | * indexed as java.lang.*. |
| duke@1 | 77 | * @param WriteedPackageHeaders the set of package headers that have already |
| duke@1 | 78 | * been indexed. We don't want to index |
| duke@1 | 79 | * something more than once. |
| duke@1 | 80 | */ |
| duke@1 | 81 | public abstract void writeLinkToPackageContent(PackageDoc pkg, String parsedPackageName, |
| jjg@74 | 82 | Set<String> WriteedPackageHeaders); |
| duke@1 | 83 | |
| duke@1 | 84 | /** |
| duke@1 | 85 | * Write the given package name. |
| duke@1 | 86 | * @param pkg the {@link PackageDoc} to index. |
| duke@1 | 87 | * @param parsedPackageName the parsed package name. We only Write the |
| duke@1 | 88 | * first 2 directory levels of the package |
| duke@1 | 89 | * name. For example, java.lang.ref would be |
| duke@1 | 90 | * indexed as java.lang.*. |
| duke@1 | 91 | */ |
| duke@1 | 92 | public abstract void writePackageName(PackageDoc pkg, |
| duke@1 | 93 | String parsedPackageName); |
| duke@1 | 94 | |
| duke@1 | 95 | /** |
| duke@1 | 96 | * Write the heading for the current table of constants for a given class. |
| duke@1 | 97 | * @param cd the class whose constants are being documented. |
| duke@1 | 98 | */ |
| duke@1 | 99 | public abstract void writeConstantMembersHeader(ClassDoc cd); |
| duke@1 | 100 | |
| duke@1 | 101 | /** |
| duke@1 | 102 | * Document the given constants. |
| duke@1 | 103 | * @param cd the class whose constants are being documented. |
| duke@1 | 104 | * @param fields the constants being documented. |
| duke@1 | 105 | */ |
| mcimadamore@184 | 106 | public abstract void writeConstantMembers(ClassDoc cd, List<FieldDoc> fields); |
| duke@1 | 107 | |
| duke@1 | 108 | /** |
| duke@1 | 109 | * Document the given constants. |
| duke@1 | 110 | * @param cd the class whose constants are being documented. |
| duke@1 | 111 | */ |
| duke@1 | 112 | public abstract void writeConstantMembersFooter(ClassDoc cd); |
| duke@1 | 113 | |
| duke@1 | 114 | } |
