Mon, 15 Dec 2008 16:55:33 -0800
6785258: Update copyright year
Summary: Update copyright for files that have been modified starting July 2008 to Dec 2008
Reviewed-by: katleman, ohair, tbell
duke@1 | 1 | /* |
duke@1 | 2 | * Copyright 2003-2004 Sun Microsystems, Inc. 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 |
duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
duke@1 | 9 | * by Sun 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 | * |
duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
duke@1 | 23 | * have any questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.formats.html; |
duke@1 | 27 | |
duke@1 | 28 | import com.sun.tools.doclets.internal.toolkit.*; |
duke@1 | 29 | import com.sun.tools.doclets.internal.toolkit.taglets.*; |
duke@1 | 30 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 31 | import com.sun.javadoc.*; |
duke@1 | 32 | |
duke@1 | 33 | import java.io.*; |
duke@1 | 34 | |
duke@1 | 35 | /** |
duke@1 | 36 | * Writes enum constant documentation in HTML format. |
duke@1 | 37 | * |
duke@1 | 38 | * @author Jamie Ho |
duke@1 | 39 | */ |
duke@1 | 40 | public class EnumConstantWriterImpl extends AbstractMemberWriter |
duke@1 | 41 | implements EnumConstantWriter, MemberSummaryWriter { |
duke@1 | 42 | |
duke@1 | 43 | private boolean printedSummaryHeader = false; |
duke@1 | 44 | |
duke@1 | 45 | public EnumConstantWriterImpl(SubWriterHolderWriter writer, |
duke@1 | 46 | ClassDoc classdoc) { |
duke@1 | 47 | super(writer, classdoc); |
duke@1 | 48 | } |
duke@1 | 49 | |
duke@1 | 50 | public EnumConstantWriterImpl(SubWriterHolderWriter writer) { |
duke@1 | 51 | super(writer); |
duke@1 | 52 | } |
duke@1 | 53 | |
duke@1 | 54 | /** |
duke@1 | 55 | * Write the enum constant summary header for the given class. |
duke@1 | 56 | * |
duke@1 | 57 | * @param classDoc the class the summary belongs to. |
duke@1 | 58 | */ |
duke@1 | 59 | public void writeMemberSummaryHeader(ClassDoc classDoc) { |
duke@1 | 60 | printedSummaryHeader = true; |
duke@1 | 61 | writer.println("<!-- =========== ENUM CONSTANT SUMMARY =========== -->"); |
duke@1 | 62 | writer.println(); |
duke@1 | 63 | writer.printSummaryHeader(this, classDoc); |
duke@1 | 64 | } |
duke@1 | 65 | |
duke@1 | 66 | /** |
duke@1 | 67 | * Write the enum constant summary footer for the given class. |
duke@1 | 68 | * |
duke@1 | 69 | * @param classDoc the class the summary belongs to. |
duke@1 | 70 | */ |
duke@1 | 71 | public void writeMemberSummaryFooter(ClassDoc classDoc) { |
duke@1 | 72 | writer.printSummaryFooter(this, classDoc); |
duke@1 | 73 | } |
duke@1 | 74 | |
duke@1 | 75 | /** |
duke@1 | 76 | * Write the inherited enum constant summary header for the given class. |
duke@1 | 77 | * |
duke@1 | 78 | * @param classDoc the class the summary belongs to. |
duke@1 | 79 | */ |
duke@1 | 80 | public void writeInheritedMemberSummaryHeader(ClassDoc classDoc) { |
duke@1 | 81 | if(! printedSummaryHeader){ |
duke@1 | 82 | //We don't want inherited summary to not be under heading. |
duke@1 | 83 | writeMemberSummaryHeader(classDoc); |
duke@1 | 84 | writeMemberSummaryFooter(classDoc); |
duke@1 | 85 | printedSummaryHeader = true; |
duke@1 | 86 | } |
duke@1 | 87 | writer.printInheritedSummaryHeader(this, classDoc); |
duke@1 | 88 | } |
duke@1 | 89 | |
duke@1 | 90 | /** |
duke@1 | 91 | * {@inheritDoc} |
duke@1 | 92 | */ |
duke@1 | 93 | public void writeInheritedMemberSummary(ClassDoc classDoc, |
duke@1 | 94 | ProgramElementDoc enumConstant, boolean isFirst, boolean isLast) { |
duke@1 | 95 | writer.printInheritedSummaryMember(this, classDoc, enumConstant, isFirst); |
duke@1 | 96 | } |
duke@1 | 97 | |
duke@1 | 98 | /** |
duke@1 | 99 | * Write the inherited enum constant summary footer for the given class. |
duke@1 | 100 | * |
duke@1 | 101 | * @param classDoc the class the summary belongs to. |
duke@1 | 102 | */ |
duke@1 | 103 | public void writeInheritedMemberSummaryFooter(ClassDoc classDoc) { |
duke@1 | 104 | writer.printInheritedSummaryFooter(this, classDoc); |
duke@1 | 105 | } |
duke@1 | 106 | |
duke@1 | 107 | /** |
duke@1 | 108 | * {@inheritDoc} |
duke@1 | 109 | */ |
duke@1 | 110 | public void writeHeader(ClassDoc classDoc, String header) { |
duke@1 | 111 | writer.println(); |
duke@1 | 112 | writer.println("<!-- ============ ENUM CONSTANT DETAIL =========== -->"); |
duke@1 | 113 | writer.println(); |
duke@1 | 114 | writer.anchor("enum_constant_detail"); |
duke@1 | 115 | writer.printTableHeadingBackground(header); |
duke@1 | 116 | writer.println(); |
duke@1 | 117 | } |
duke@1 | 118 | |
duke@1 | 119 | /** |
duke@1 | 120 | * {@inheritDoc} |
duke@1 | 121 | */ |
duke@1 | 122 | public void writeEnumConstantHeader(FieldDoc enumConstant, boolean isFirst) { |
duke@1 | 123 | if (! isFirst) { |
duke@1 | 124 | writer.printMemberHeader(); |
duke@1 | 125 | writer.println(""); |
duke@1 | 126 | } |
duke@1 | 127 | writer.anchor(enumConstant.name()); |
duke@1 | 128 | writer.h3(); |
duke@1 | 129 | writer.print(enumConstant.name()); |
duke@1 | 130 | writer.h3End(); |
duke@1 | 131 | } |
duke@1 | 132 | |
duke@1 | 133 | /** |
duke@1 | 134 | * {@inheritDoc} |
duke@1 | 135 | */ |
duke@1 | 136 | public void writeSignature(FieldDoc enumConstant) { |
duke@1 | 137 | writer.pre(); |
duke@1 | 138 | writer.writeAnnotationInfo(enumConstant); |
duke@1 | 139 | printModifiers(enumConstant); |
duke@1 | 140 | writer.printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER, |
duke@1 | 141 | enumConstant.type())); |
duke@1 | 142 | print(' '); |
duke@1 | 143 | if (configuration().linksource) { |
duke@1 | 144 | writer.printSrcLink(enumConstant, enumConstant.name()); |
duke@1 | 145 | } else { |
duke@1 | 146 | bold(enumConstant.name()); |
duke@1 | 147 | } |
duke@1 | 148 | writer.preEnd(); |
duke@1 | 149 | writer.dl(); |
duke@1 | 150 | } |
duke@1 | 151 | |
duke@1 | 152 | /** |
duke@1 | 153 | * {@inheritDoc} |
duke@1 | 154 | */ |
duke@1 | 155 | public void writeDeprecated(FieldDoc enumConstant) { |
duke@1 | 156 | print(((TagletOutputImpl) |
duke@1 | 157 | (new DeprecatedTaglet()).getTagletOutput(enumConstant, |
duke@1 | 158 | writer.getTagletWriterInstance(false))).toString()); |
duke@1 | 159 | } |
duke@1 | 160 | |
duke@1 | 161 | /** |
duke@1 | 162 | * {@inheritDoc} |
duke@1 | 163 | */ |
duke@1 | 164 | public void writeComments(FieldDoc enumConstant) { |
duke@1 | 165 | if (enumConstant.inlineTags().length > 0) { |
duke@1 | 166 | writer.dd(); |
duke@1 | 167 | writer.printInlineComment(enumConstant); |
duke@1 | 168 | } |
duke@1 | 169 | } |
duke@1 | 170 | |
duke@1 | 171 | /** |
duke@1 | 172 | * {@inheritDoc} |
duke@1 | 173 | */ |
duke@1 | 174 | public void writeTags(FieldDoc enumConstant) { |
duke@1 | 175 | writer.printTags(enumConstant); |
duke@1 | 176 | } |
duke@1 | 177 | |
duke@1 | 178 | /** |
duke@1 | 179 | * {@inheritDoc} |
duke@1 | 180 | */ |
duke@1 | 181 | public void writeEnumConstantFooter() { |
duke@1 | 182 | writer.dlEnd(); |
duke@1 | 183 | } |
duke@1 | 184 | |
duke@1 | 185 | /** |
duke@1 | 186 | * {@inheritDoc} |
duke@1 | 187 | */ |
duke@1 | 188 | public void writeFooter(ClassDoc classDoc) { |
duke@1 | 189 | //No footer to write for enum constant documentation |
duke@1 | 190 | } |
duke@1 | 191 | |
duke@1 | 192 | /** |
duke@1 | 193 | * {@inheritDoc} |
duke@1 | 194 | */ |
duke@1 | 195 | public void close() throws IOException { |
duke@1 | 196 | writer.close(); |
duke@1 | 197 | } |
duke@1 | 198 | |
duke@1 | 199 | public int getMemberKind() { |
duke@1 | 200 | return VisibleMemberMap.ENUM_CONSTANTS; |
duke@1 | 201 | } |
duke@1 | 202 | |
duke@1 | 203 | public void printSummaryLabel(ClassDoc cd) { |
duke@1 | 204 | writer.boldText("doclet.Enum_Constant_Summary"); |
duke@1 | 205 | } |
duke@1 | 206 | |
duke@1 | 207 | public void printSummaryAnchor(ClassDoc cd) { |
duke@1 | 208 | writer.anchor("enum_constant_summary"); |
duke@1 | 209 | } |
duke@1 | 210 | |
duke@1 | 211 | public void printInheritedSummaryAnchor(ClassDoc cd) { |
duke@1 | 212 | } // no such |
duke@1 | 213 | |
duke@1 | 214 | public void printInheritedSummaryLabel(ClassDoc cd) { |
duke@1 | 215 | // no such |
duke@1 | 216 | } |
duke@1 | 217 | |
duke@1 | 218 | protected void writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member) { |
duke@1 | 219 | writer.bold(); |
duke@1 | 220 | writer.printDocLink(context, (MemberDoc) member, member.name(), false); |
duke@1 | 221 | writer.boldEnd(); |
duke@1 | 222 | } |
duke@1 | 223 | |
duke@1 | 224 | protected void writeInheritedSummaryLink(ClassDoc cd, |
duke@1 | 225 | ProgramElementDoc member) { |
duke@1 | 226 | writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER, (MemberDoc)member, |
duke@1 | 227 | member.name(), false); |
duke@1 | 228 | } |
duke@1 | 229 | |
duke@1 | 230 | protected void printSummaryType(ProgramElementDoc member) { |
duke@1 | 231 | //Not applicable. |
duke@1 | 232 | } |
duke@1 | 233 | |
duke@1 | 234 | protected void writeDeprecatedLink(ProgramElementDoc member) { |
duke@1 | 235 | writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER, |
duke@1 | 236 | (MemberDoc) member, ((FieldDoc)member).qualifiedName(), false); |
duke@1 | 237 | } |
duke@1 | 238 | |
duke@1 | 239 | protected void printNavSummaryLink(ClassDoc cd, boolean link) { |
duke@1 | 240 | if (link) { |
duke@1 | 241 | writer.printHyperLink("", (cd == null)? |
duke@1 | 242 | "enum_constant_summary": |
duke@1 | 243 | "enum_constants_inherited_from_class_" + |
duke@1 | 244 | configuration().getClassName(cd), |
duke@1 | 245 | configuration().getText("doclet.navEnum")); |
duke@1 | 246 | } else { |
duke@1 | 247 | writer.printText("doclet.navEnum"); |
duke@1 | 248 | } |
duke@1 | 249 | } |
duke@1 | 250 | |
duke@1 | 251 | protected void printNavDetailLink(boolean link) { |
duke@1 | 252 | if (link) { |
duke@1 | 253 | writer.printHyperLink("", "enum_constant_detail", |
duke@1 | 254 | configuration().getText("doclet.navEnum")); |
duke@1 | 255 | } else { |
duke@1 | 256 | writer.printText("doclet.navEnum"); |
duke@1 | 257 | } |
duke@1 | 258 | } |
duke@1 | 259 | } |