Thu, 13 Jan 2011 21:28:38 -0800
7010528: javadoc performance regression
Reviewed-by: jjg
duke@1 | 1 | /* |
ohair@798 | 2 | * Copyright (c) 2003, 2010, 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.formats.html; |
duke@1 | 27 | |
bpatel@233 | 28 | import java.io.*; |
bpatel@233 | 29 | |
bpatel@233 | 30 | import com.sun.javadoc.*; |
bpatel@766 | 31 | import com.sun.tools.doclets.formats.html.markup.*; |
duke@1 | 32 | import com.sun.tools.doclets.internal.toolkit.*; |
duke@1 | 33 | import com.sun.tools.doclets.internal.toolkit.util.*; |
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 |
bpatel@243 | 39 | * @author Bhavesh Patel (Modified) |
duke@1 | 40 | */ |
duke@1 | 41 | public class EnumConstantWriterImpl extends AbstractMemberWriter |
duke@1 | 42 | implements EnumConstantWriter, MemberSummaryWriter { |
duke@1 | 43 | |
duke@1 | 44 | public EnumConstantWriterImpl(SubWriterHolderWriter writer, |
duke@1 | 45 | ClassDoc classdoc) { |
duke@1 | 46 | super(writer, classdoc); |
duke@1 | 47 | } |
duke@1 | 48 | |
duke@1 | 49 | public EnumConstantWriterImpl(SubWriterHolderWriter writer) { |
duke@1 | 50 | super(writer); |
duke@1 | 51 | } |
duke@1 | 52 | |
duke@1 | 53 | /** |
bpatel@766 | 54 | * {@inheritDoc} |
duke@1 | 55 | */ |
bpatel@766 | 56 | public Content getMemberSummaryHeader(ClassDoc classDoc, |
bpatel@766 | 57 | Content memberSummaryTree) { |
bpatel@766 | 58 | memberSummaryTree.addContent(HtmlConstants.START_OF_ENUM_CONSTANT_SUMMARY); |
bpatel@766 | 59 | Content memberTree = writer.getMemberTreeHeader(); |
bpatel@766 | 60 | writer.addSummaryHeader(this, classDoc, memberTree); |
bpatel@766 | 61 | return memberTree; |
duke@1 | 62 | } |
duke@1 | 63 | |
duke@1 | 64 | /** |
duke@1 | 65 | * {@inheritDoc} |
duke@1 | 66 | */ |
bpatel@766 | 67 | public Content getEnumConstantsDetailsTreeHeader(ClassDoc classDoc, |
bpatel@766 | 68 | Content memberDetailsTree) { |
bpatel@766 | 69 | memberDetailsTree.addContent(HtmlConstants.START_OF_ENUM_CONSTANT_DETAILS); |
bpatel@766 | 70 | Content enumConstantsDetailsTree = writer.getMemberTreeHeader(); |
bpatel@766 | 71 | enumConstantsDetailsTree.addContent(writer.getMarkerAnchor("enum_constant_detail")); |
bpatel@766 | 72 | Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING, |
bpatel@766 | 73 | writer.enumConstantsDetailsLabel); |
bpatel@766 | 74 | enumConstantsDetailsTree.addContent(heading); |
bpatel@766 | 75 | return enumConstantsDetailsTree; |
duke@1 | 76 | } |
duke@1 | 77 | |
duke@1 | 78 | /** |
duke@1 | 79 | * {@inheritDoc} |
duke@1 | 80 | */ |
bpatel@766 | 81 | public Content getEnumConstantsTreeHeader(FieldDoc enumConstant, |
bpatel@766 | 82 | Content enumConstantsDetailsTree) { |
bpatel@766 | 83 | enumConstantsDetailsTree.addContent( |
bpatel@766 | 84 | writer.getMarkerAnchor(enumConstant.name())); |
bpatel@766 | 85 | Content enumConstantsTree = writer.getMemberTreeHeader(); |
bpatel@766 | 86 | Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING); |
bpatel@766 | 87 | heading.addContent(enumConstant.name()); |
bpatel@766 | 88 | enumConstantsTree.addContent(heading); |
bpatel@766 | 89 | return enumConstantsTree; |
duke@1 | 90 | } |
duke@1 | 91 | |
duke@1 | 92 | /** |
duke@1 | 93 | * {@inheritDoc} |
duke@1 | 94 | */ |
bpatel@766 | 95 | public Content getSignature(FieldDoc enumConstant) { |
bpatel@766 | 96 | Content pre = new HtmlTree(HtmlTag.PRE); |
bpatel@766 | 97 | writer.addAnnotationInfo(enumConstant, pre); |
bpatel@766 | 98 | addModifiers(enumConstant, pre); |
bpatel@766 | 99 | Content enumConstantLink = new RawHtml(writer.getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER, |
bpatel@766 | 100 | enumConstant.type()))); |
bpatel@766 | 101 | pre.addContent(enumConstantLink); |
bpatel@766 | 102 | pre.addContent(" "); |
bpatel@766 | 103 | if (configuration().linksource) { |
bpatel@766 | 104 | Content enumConstantName = new StringContent(enumConstant.name()); |
bpatel@766 | 105 | writer.addSrcLink(enumConstant, enumConstantName, pre); |
bpatel@766 | 106 | } else { |
bpatel@766 | 107 | addName(enumConstant.name(), pre); |
duke@1 | 108 | } |
bpatel@766 | 109 | return pre; |
duke@1 | 110 | } |
duke@1 | 111 | |
duke@1 | 112 | /** |
duke@1 | 113 | * {@inheritDoc} |
duke@1 | 114 | */ |
bpatel@766 | 115 | public void addDeprecated(FieldDoc enumConstant, Content enumConstantsTree) { |
bpatel@766 | 116 | addDeprecatedInfo(enumConstant, enumConstantsTree); |
duke@1 | 117 | } |
duke@1 | 118 | |
duke@1 | 119 | /** |
duke@1 | 120 | * {@inheritDoc} |
duke@1 | 121 | */ |
bpatel@766 | 122 | public void addComments(FieldDoc enumConstant, Content enumConstantsTree) { |
bpatel@766 | 123 | addComment(enumConstant, enumConstantsTree); |
duke@1 | 124 | } |
duke@1 | 125 | |
duke@1 | 126 | /** |
duke@1 | 127 | * {@inheritDoc} |
duke@1 | 128 | */ |
bpatel@766 | 129 | public void addTags(FieldDoc enumConstant, Content enumConstantsTree) { |
bpatel@766 | 130 | writer.addTagsInfo(enumConstant, enumConstantsTree); |
duke@1 | 131 | } |
duke@1 | 132 | |
duke@1 | 133 | /** |
duke@1 | 134 | * {@inheritDoc} |
duke@1 | 135 | */ |
bpatel@766 | 136 | public Content getEnumConstantsDetails(Content enumConstantsDetailsTree) { |
bpatel@766 | 137 | return getMemberTree(enumConstantsDetailsTree); |
duke@1 | 138 | } |
duke@1 | 139 | |
duke@1 | 140 | /** |
duke@1 | 141 | * {@inheritDoc} |
duke@1 | 142 | */ |
bpatel@766 | 143 | public Content getEnumConstants(Content enumConstantsTree, |
bpatel@766 | 144 | boolean isLastContent) { |
bpatel@766 | 145 | return getMemberTree(enumConstantsTree, isLastContent); |
duke@1 | 146 | } |
duke@1 | 147 | |
duke@1 | 148 | /** |
duke@1 | 149 | * {@inheritDoc} |
duke@1 | 150 | */ |
duke@1 | 151 | public void close() throws IOException { |
duke@1 | 152 | writer.close(); |
duke@1 | 153 | } |
duke@1 | 154 | |
duke@1 | 155 | public int getMemberKind() { |
duke@1 | 156 | return VisibleMemberMap.ENUM_CONSTANTS; |
duke@1 | 157 | } |
duke@1 | 158 | |
bpatel@766 | 159 | /** |
bpatel@766 | 160 | * {@inheritDoc} |
bpatel@766 | 161 | */ |
bpatel@766 | 162 | public void addSummaryLabel(Content memberTree) { |
bpatel@766 | 163 | Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING, |
bpatel@766 | 164 | writer.getResource("doclet.Enum_Constant_Summary")); |
bpatel@766 | 165 | memberTree.addContent(label); |
bpatel@243 | 166 | } |
bpatel@243 | 167 | |
bpatel@766 | 168 | /** |
bpatel@766 | 169 | * {@inheritDoc} |
bpatel@766 | 170 | */ |
bpatel@766 | 171 | public String getTableSummary() { |
bpatel@766 | 172 | return configuration().getText("doclet.Member_Table_Summary", |
bpatel@243 | 173 | configuration().getText("doclet.Enum_Constant_Summary"), |
bpatel@766 | 174 | configuration().getText("doclet.enum_constants")); |
bpatel@243 | 175 | } |
bpatel@243 | 176 | |
bpatel@766 | 177 | /** |
bpatel@766 | 178 | * {@inheritDoc} |
bpatel@766 | 179 | */ |
bpatel@766 | 180 | public String getCaption() { |
bpatel@766 | 181 | return configuration().getText("doclet.Enum_Constants"); |
bpatel@766 | 182 | } |
bpatel@766 | 183 | |
bpatel@766 | 184 | /** |
bpatel@766 | 185 | * {@inheritDoc} |
bpatel@766 | 186 | */ |
bpatel@766 | 187 | public String[] getSummaryTableHeader(ProgramElementDoc member) { |
bpatel@243 | 188 | String[] header = new String[] { |
bpatel@243 | 189 | configuration().getText("doclet.0_and_1", |
bpatel@243 | 190 | configuration().getText("doclet.Enum_Constant"), |
bpatel@243 | 191 | configuration().getText("doclet.Description")) |
bpatel@243 | 192 | }; |
bpatel@766 | 193 | return header; |
duke@1 | 194 | } |
duke@1 | 195 | |
bpatel@766 | 196 | /** |
bpatel@766 | 197 | * {@inheritDoc} |
bpatel@766 | 198 | */ |
bpatel@766 | 199 | public void addSummaryAnchor(ClassDoc cd, Content memberTree) { |
bpatel@766 | 200 | memberTree.addContent(writer.getMarkerAnchor("enum_constant_summary")); |
duke@1 | 201 | } |
duke@1 | 202 | |
bpatel@766 | 203 | /** |
bpatel@766 | 204 | * {@inheritDoc} |
bpatel@766 | 205 | */ |
bpatel@766 | 206 | public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) { |
duke@1 | 207 | } |
duke@1 | 208 | |
bpatel@766 | 209 | /** |
bpatel@766 | 210 | * {@inheritDoc} |
bpatel@766 | 211 | */ |
bpatel@766 | 212 | public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) { |
duke@1 | 213 | } |
duke@1 | 214 | |
bpatel@766 | 215 | /** |
bpatel@766 | 216 | * {@inheritDoc} |
bpatel@766 | 217 | */ |
bpatel@766 | 218 | protected void addSummaryLink(int context, ClassDoc cd, ProgramElementDoc member, |
bpatel@766 | 219 | Content tdSummary) { |
bpatel@766 | 220 | Content strong = HtmlTree.STRONG(new RawHtml( |
bpatel@766 | 221 | writer.getDocLink(context, (MemberDoc) member, member.name(), false))); |
bpatel@766 | 222 | Content code = HtmlTree.CODE(strong); |
bpatel@766 | 223 | tdSummary.addContent(code); |
duke@1 | 224 | } |
duke@1 | 225 | |
bpatel@766 | 226 | /** |
bpatel@766 | 227 | * {@inheritDoc} |
bpatel@766 | 228 | */ |
bpatel@766 | 229 | @Override |
bpatel@766 | 230 | public void setSummaryColumnStyle(HtmlTree tdTree) { |
bpatel@766 | 231 | tdTree.addStyle(HtmlStyle.colOne); |
bpatel@766 | 232 | } |
bpatel@766 | 233 | |
bpatel@766 | 234 | /** |
bpatel@766 | 235 | * {@inheritDoc} |
bpatel@766 | 236 | */ |
bpatel@766 | 237 | protected void addInheritedSummaryLink(ClassDoc cd, |
bpatel@766 | 238 | ProgramElementDoc member, Content linksTree) { |
bpatel@766 | 239 | } |
bpatel@766 | 240 | |
bpatel@766 | 241 | /** |
bpatel@766 | 242 | * {@inheritDoc} |
bpatel@766 | 243 | */ |
bpatel@766 | 244 | protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) { |
duke@1 | 245 | //Not applicable. |
duke@1 | 246 | } |
duke@1 | 247 | |
bpatel@766 | 248 | /** |
bpatel@766 | 249 | * {@inheritDoc} |
bpatel@766 | 250 | */ |
bpatel@766 | 251 | protected Content getDeprecatedLink(ProgramElementDoc member) { |
bpatel@766 | 252 | return writer.getDocLink(LinkInfoImpl.CONTEXT_MEMBER, |
bpatel@766 | 253 | (MemberDoc) member, ((FieldDoc)member).qualifiedName()); |
duke@1 | 254 | } |
duke@1 | 255 | |
bpatel@766 | 256 | /** |
bpatel@766 | 257 | * {@inheritDoc} |
bpatel@766 | 258 | */ |
bpatel@766 | 259 | protected Content getNavSummaryLink(ClassDoc cd, boolean link) { |
duke@1 | 260 | if (link) { |
bpatel@766 | 261 | return writer.getHyperLink("", (cd == null)? |
bpatel@766 | 262 | "enum_constant_summary": |
bpatel@766 | 263 | "enum_constants_inherited_from_class_" + |
bpatel@766 | 264 | configuration().getClassName(cd), |
bpatel@766 | 265 | writer.getResource("doclet.navEnum")); |
duke@1 | 266 | } else { |
bpatel@766 | 267 | return writer.getResource("doclet.navEnum"); |
duke@1 | 268 | } |
duke@1 | 269 | } |
duke@1 | 270 | |
bpatel@766 | 271 | /** |
bpatel@766 | 272 | * {@inheritDoc} |
bpatel@766 | 273 | */ |
bpatel@766 | 274 | protected void addNavDetailLink(boolean link, Content liNav) { |
duke@1 | 275 | if (link) { |
bpatel@766 | 276 | liNav.addContent(writer.getHyperLink("", "enum_constant_detail", |
bpatel@766 | 277 | writer.getResource("doclet.navEnum"))); |
duke@1 | 278 | } else { |
bpatel@766 | 279 | liNav.addContent(writer.getResource("doclet.navEnum")); |
duke@1 | 280 | } |
duke@1 | 281 | } |
duke@1 | 282 | } |