Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/ConstantsSummaryWriter.java@959103a6100f (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/ConstantsSummaryWriter.java
Wed, 27 Apr 2016 01:34:52 +0800
- author
- aoqi
- date
- Wed, 27 Apr 2016 01:34:52 +0800
- changeset 0
- 959103a6100f
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.tools.doclets.internal.toolkit; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.io.*; |
| aoqi@0 | 29 | import java.util.*; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | import com.sun.javadoc.*; |
| aoqi@0 | 32 | |
| aoqi@0 | 33 | /** |
| aoqi@0 | 34 | * The interface for writing constants summary output. |
| aoqi@0 | 35 | * |
| aoqi@0 | 36 | * <p><b>This is NOT part of any supported API. |
| aoqi@0 | 37 | * If you write code that depends on this, you do so at your own risk. |
| aoqi@0 | 38 | * This code and its internal interfaces are subject to change or |
| aoqi@0 | 39 | * deletion without notice.</b> |
| aoqi@0 | 40 | * |
| aoqi@0 | 41 | * @author Jamie Ho |
| aoqi@0 | 42 | * @author Bhavesh Patel (Modified) |
| aoqi@0 | 43 | * @since 1.5 |
| aoqi@0 | 44 | */ |
| aoqi@0 | 45 | |
| aoqi@0 | 46 | public interface ConstantsSummaryWriter { |
| aoqi@0 | 47 | |
| aoqi@0 | 48 | /** |
| aoqi@0 | 49 | * Close the writer. |
| aoqi@0 | 50 | */ |
| aoqi@0 | 51 | public abstract void close() throws IOException; |
| aoqi@0 | 52 | |
| aoqi@0 | 53 | /** |
| aoqi@0 | 54 | * Get the header for the constant summary documentation. |
| aoqi@0 | 55 | * |
| aoqi@0 | 56 | * @return header that needs to be added to the documentation |
| aoqi@0 | 57 | */ |
| aoqi@0 | 58 | public abstract Content getHeader(); |
| aoqi@0 | 59 | |
| aoqi@0 | 60 | /** |
| aoqi@0 | 61 | * Get the header for the constant content list. |
| aoqi@0 | 62 | * |
| aoqi@0 | 63 | * @return content header that needs to be added to the documentation |
| aoqi@0 | 64 | */ |
| aoqi@0 | 65 | public abstract Content getContentsHeader(); |
| aoqi@0 | 66 | |
| aoqi@0 | 67 | /** |
| aoqi@0 | 68 | * Adds the given package name link to the constant content list tree. |
| aoqi@0 | 69 | * |
| aoqi@0 | 70 | * @param pkg the {@link PackageDoc} to index. |
| aoqi@0 | 71 | * @param parsedPackageName the parsed package name. We only Write the |
| aoqi@0 | 72 | * first 2 directory levels of the package |
| aoqi@0 | 73 | * name. For example, java.lang.ref would be |
| aoqi@0 | 74 | * indexed as java.lang.*. |
| aoqi@0 | 75 | * @param WriteedPackageHeaders the set of package headers that have already |
| aoqi@0 | 76 | * been indexed. We don't want to index |
| aoqi@0 | 77 | * something more than once. |
| aoqi@0 | 78 | * @param contentListTree the content tree to which the link will be added |
| aoqi@0 | 79 | */ |
| aoqi@0 | 80 | public abstract void addLinkToPackageContent(PackageDoc pkg, String parsedPackageName, |
| aoqi@0 | 81 | Set<String> WriteedPackageHeaders, Content contentListTree); |
| aoqi@0 | 82 | |
| aoqi@0 | 83 | /** |
| aoqi@0 | 84 | * Get the content list to be added to the documentation tree. |
| aoqi@0 | 85 | * |
| aoqi@0 | 86 | * @param contentListTree the content that will be added to the list |
| aoqi@0 | 87 | * @return content list that will be added to the documentation tree |
| aoqi@0 | 88 | */ |
| aoqi@0 | 89 | public abstract Content getContentsList(Content contentListTree); |
| aoqi@0 | 90 | |
| aoqi@0 | 91 | /** |
| aoqi@0 | 92 | * Get the constant summaries for the document. |
| aoqi@0 | 93 | * |
| aoqi@0 | 94 | * @return constant summaries header to be added to the documentation tree |
| aoqi@0 | 95 | */ |
| aoqi@0 | 96 | public abstract Content getConstantSummaries(); |
| aoqi@0 | 97 | |
| aoqi@0 | 98 | /** |
| aoqi@0 | 99 | * Adds the given package name. |
| aoqi@0 | 100 | * |
| aoqi@0 | 101 | * @param pkg the {@link PackageDoc} to index. |
| aoqi@0 | 102 | * @param parsedPackageName the parsed package name. We only Write the |
| aoqi@0 | 103 | * first 2 directory levels of the package |
| aoqi@0 | 104 | * name. For example, java.lang.ref would be |
| aoqi@0 | 105 | * indexed as java.lang.*. |
| aoqi@0 | 106 | * @param summariesTree the documentation tree to which the package name will |
| aoqi@0 | 107 | * be written |
| aoqi@0 | 108 | */ |
| aoqi@0 | 109 | public abstract void addPackageName(PackageDoc pkg, |
| aoqi@0 | 110 | String parsedPackageName, Content summariesTree); |
| aoqi@0 | 111 | |
| aoqi@0 | 112 | /** |
| aoqi@0 | 113 | * Get the class summary header for the constants summary. |
| aoqi@0 | 114 | * |
| aoqi@0 | 115 | * @return the header content for the class constants summary |
| aoqi@0 | 116 | */ |
| aoqi@0 | 117 | public abstract Content getClassConstantHeader(); |
| aoqi@0 | 118 | |
| aoqi@0 | 119 | /** |
| aoqi@0 | 120 | * Adds the constant member table to the documentation tree. |
| aoqi@0 | 121 | * |
| aoqi@0 | 122 | * @param cd the class whose constants are being documented. |
| aoqi@0 | 123 | * @param fields the constants being documented. |
| aoqi@0 | 124 | * @param classConstantTree the documentation tree to which theconstant member |
| aoqi@0 | 125 | * table content will be added |
| aoqi@0 | 126 | */ |
| aoqi@0 | 127 | public abstract void addConstantMembers(ClassDoc cd, List<FieldDoc> fields, |
| aoqi@0 | 128 | Content classConstantTree); |
| aoqi@0 | 129 | |
| aoqi@0 | 130 | /** |
| aoqi@0 | 131 | * Adds the footer for the summary documentation. |
| aoqi@0 | 132 | * |
| aoqi@0 | 133 | * @param contentTree content tree to which the footer will be added |
| aoqi@0 | 134 | */ |
| aoqi@0 | 135 | public abstract void addFooter(Content contentTree); |
| aoqi@0 | 136 | |
| aoqi@0 | 137 | /** |
| aoqi@0 | 138 | * Print the constants summary document. |
| aoqi@0 | 139 | * |
| aoqi@0 | 140 | * @param contentTree content tree which should be printed |
| aoqi@0 | 141 | */ |
| aoqi@0 | 142 | public abstract void printDocument(Content contentTree) throws IOException; |
| aoqi@0 | 143 | |
| aoqi@0 | 144 | } |
