Wed, 01 Dec 2010 11:02:38 -0800
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
Reviewed-by: jjg
duke@1 | 1 | /* |
ohair@554 | 2 | * Copyright (c) 2003, 2004, 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 | |
duke@1 | 34 | /** |
duke@1 | 35 | * Writes annotation type required member documentation in HTML format. |
duke@1 | 36 | * |
duke@1 | 37 | * @author Jamie Ho |
bpatel@243 | 38 | * @author Bhavesh Patel (Modified) |
duke@1 | 39 | */ |
duke@1 | 40 | public class AnnotationTypeRequiredMemberWriterImpl extends AbstractMemberWriter |
duke@1 | 41 | implements AnnotationTypeRequiredMemberWriter, MemberSummaryWriter { |
duke@1 | 42 | |
duke@1 | 43 | /** |
duke@1 | 44 | * Construct a new AnnotationTypeRequiredMemberWriterImpl. |
duke@1 | 45 | * |
duke@1 | 46 | * @param writer the writer that will write the output. |
duke@1 | 47 | * @param annotationType the AnnotationType that holds this member. |
duke@1 | 48 | */ |
duke@1 | 49 | public AnnotationTypeRequiredMemberWriterImpl(SubWriterHolderWriter writer, |
duke@1 | 50 | AnnotationTypeDoc annotationType) { |
duke@1 | 51 | super(writer, annotationType); |
duke@1 | 52 | } |
duke@1 | 53 | |
duke@1 | 54 | /** |
bpatel@766 | 55 | * {@inheritDoc} |
duke@1 | 56 | */ |
bpatel@766 | 57 | public Content getMemberSummaryHeader(ClassDoc classDoc, |
bpatel@766 | 58 | Content memberSummaryTree) { |
bpatel@766 | 59 | memberSummaryTree.addContent( |
bpatel@766 | 60 | HtmlConstants.START_OF_ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY); |
bpatel@766 | 61 | Content memberTree = writer.getMemberTreeHeader(); |
bpatel@766 | 62 | writer.addSummaryHeader(this, classDoc, memberTree); |
bpatel@766 | 63 | return memberTree; |
duke@1 | 64 | } |
duke@1 | 65 | |
duke@1 | 66 | /** |
duke@1 | 67 | * {@inheritDoc} |
duke@1 | 68 | */ |
bpatel@766 | 69 | public void addAnnotationDetailsTreeHeader(ClassDoc classDoc, |
bpatel@766 | 70 | Content memberDetailsTree) { |
bpatel@766 | 71 | if (!writer.printedAnnotationHeading) { |
bpatel@766 | 72 | memberDetailsTree.addContent(writer.getMarkerAnchor( |
bpatel@766 | 73 | "annotation_type_element_detail")); |
bpatel@766 | 74 | Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING, |
bpatel@766 | 75 | writer.annotationTypeDetailsLabel); |
bpatel@766 | 76 | memberDetailsTree.addContent(heading); |
bpatel@766 | 77 | writer.printedAnnotationHeading = true; |
bpatel@766 | 78 | } |
duke@1 | 79 | } |
duke@1 | 80 | |
duke@1 | 81 | /** |
duke@1 | 82 | * {@inheritDoc} |
duke@1 | 83 | */ |
bpatel@766 | 84 | public Content getAnnotationDocTreeHeader(MemberDoc member, |
bpatel@766 | 85 | Content annotationDetailsTree) { |
bpatel@766 | 86 | annotationDetailsTree.addContent( |
bpatel@766 | 87 | writer.getMarkerAnchor(member.name() + |
bpatel@766 | 88 | ((ExecutableMemberDoc) member).signature())); |
bpatel@766 | 89 | Content annotationDocTree = writer.getMemberTreeHeader(); |
bpatel@766 | 90 | Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING); |
bpatel@766 | 91 | heading.addContent(member.name()); |
bpatel@766 | 92 | annotationDocTree.addContent(heading); |
bpatel@766 | 93 | return annotationDocTree; |
duke@1 | 94 | } |
duke@1 | 95 | |
duke@1 | 96 | /** |
duke@1 | 97 | * {@inheritDoc} |
duke@1 | 98 | */ |
bpatel@766 | 99 | public Content getSignature(MemberDoc member) { |
bpatel@766 | 100 | Content pre = new HtmlTree(HtmlTag.PRE); |
bpatel@766 | 101 | writer.addAnnotationInfo(member, pre); |
bpatel@766 | 102 | addModifiers(member, pre); |
bpatel@766 | 103 | Content link = new RawHtml( |
bpatel@766 | 104 | writer.getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER, |
bpatel@766 | 105 | getType(member)))); |
bpatel@766 | 106 | pre.addContent(link); |
bpatel@766 | 107 | pre.addContent(writer.getSpace()); |
bpatel@766 | 108 | if (configuration().linksource) { |
bpatel@766 | 109 | Content memberName = new StringContent(member.name()); |
bpatel@766 | 110 | writer.addSrcLink(member, memberName, pre); |
bpatel@766 | 111 | } else { |
bpatel@766 | 112 | addName(member.name(), pre); |
bpatel@766 | 113 | } |
bpatel@766 | 114 | return pre; |
duke@1 | 115 | } |
duke@1 | 116 | |
duke@1 | 117 | /** |
duke@1 | 118 | * {@inheritDoc} |
duke@1 | 119 | */ |
bpatel@766 | 120 | public void addDeprecated(MemberDoc member, Content annotationDocTree) { |
bpatel@766 | 121 | addDeprecatedInfo(member, annotationDocTree); |
duke@1 | 122 | } |
duke@1 | 123 | |
duke@1 | 124 | /** |
duke@1 | 125 | * {@inheritDoc} |
duke@1 | 126 | */ |
bpatel@766 | 127 | public void addComments(MemberDoc member, Content annotationDocTree) { |
bpatel@766 | 128 | addComment(member, annotationDocTree); |
duke@1 | 129 | } |
duke@1 | 130 | |
duke@1 | 131 | /** |
duke@1 | 132 | * {@inheritDoc} |
duke@1 | 133 | */ |
bpatel@766 | 134 | public void addTags(MemberDoc member, Content annotationDocTree) { |
bpatel@766 | 135 | writer.addTagsInfo(member, annotationDocTree); |
duke@1 | 136 | } |
duke@1 | 137 | |
duke@1 | 138 | /** |
duke@1 | 139 | * {@inheritDoc} |
duke@1 | 140 | */ |
bpatel@766 | 141 | public Content getAnnotationDetails(Content annotationDetailsTree) { |
bpatel@766 | 142 | return getMemberTree(annotationDetailsTree); |
duke@1 | 143 | } |
duke@1 | 144 | |
duke@1 | 145 | /** |
bpatel@766 | 146 | * {@inheritDoc} |
duke@1 | 147 | */ |
bpatel@766 | 148 | public Content getAnnotationDoc(Content annotationDocTree, |
bpatel@766 | 149 | boolean isLastContent) { |
bpatel@766 | 150 | return getMemberTree(annotationDocTree, isLastContent); |
duke@1 | 151 | } |
duke@1 | 152 | |
duke@1 | 153 | /** |
duke@1 | 154 | * Close the writer. |
duke@1 | 155 | */ |
duke@1 | 156 | public void close() throws IOException { |
duke@1 | 157 | writer.close(); |
duke@1 | 158 | } |
duke@1 | 159 | |
duke@1 | 160 | /** |
duke@1 | 161 | * {@inheritDoc} |
duke@1 | 162 | */ |
bpatel@766 | 163 | public void addSummaryLabel(Content memberTree) { |
bpatel@766 | 164 | Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING, |
bpatel@766 | 165 | writer.getResource("doclet.Annotation_Type_Required_Member_Summary")); |
bpatel@766 | 166 | memberTree.addContent(label); |
bpatel@243 | 167 | } |
bpatel@243 | 168 | |
bpatel@243 | 169 | /** |
bpatel@243 | 170 | * {@inheritDoc} |
bpatel@243 | 171 | */ |
bpatel@766 | 172 | public String getTableSummary() { |
bpatel@766 | 173 | return configuration().getText("doclet.Member_Table_Summary", |
bpatel@243 | 174 | configuration().getText("doclet.Annotation_Type_Required_Member_Summary"), |
bpatel@766 | 175 | configuration().getText("doclet.annotation_type_required_members")); |
bpatel@243 | 176 | } |
bpatel@243 | 177 | |
bpatel@766 | 178 | /** |
bpatel@766 | 179 | * {@inheritDoc} |
bpatel@766 | 180 | */ |
bpatel@766 | 181 | public String getCaption() { |
bpatel@766 | 182 | return configuration().getText("doclet.Annotation_Type_Required_Members"); |
bpatel@766 | 183 | } |
bpatel@766 | 184 | |
bpatel@766 | 185 | /** |
bpatel@766 | 186 | * {@inheritDoc} |
bpatel@766 | 187 | */ |
bpatel@766 | 188 | public String[] getSummaryTableHeader(ProgramElementDoc member) { |
bpatel@243 | 189 | String[] header = new String[] { |
bpatel@243 | 190 | writer.getModifierTypeHeader(), |
bpatel@243 | 191 | configuration().getText("doclet.0_and_1", |
bpatel@243 | 192 | configuration().getText("doclet.Annotation_Type_Required_Member"), |
bpatel@243 | 193 | configuration().getText("doclet.Description")) |
bpatel@243 | 194 | }; |
bpatel@766 | 195 | return header; |
duke@1 | 196 | } |
duke@1 | 197 | |
duke@1 | 198 | /** |
duke@1 | 199 | * {@inheritDoc} |
duke@1 | 200 | */ |
bpatel@766 | 201 | public void addSummaryAnchor(ClassDoc cd, Content memberTree) { |
bpatel@766 | 202 | memberTree.addContent(writer.getMarkerAnchor( |
bpatel@766 | 203 | "annotation_type_required_element_summary")); |
duke@1 | 204 | } |
duke@1 | 205 | |
duke@1 | 206 | /** |
duke@1 | 207 | * {@inheritDoc} |
duke@1 | 208 | */ |
bpatel@766 | 209 | public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) { |
duke@1 | 210 | } |
duke@1 | 211 | |
duke@1 | 212 | /** |
duke@1 | 213 | * {@inheritDoc} |
duke@1 | 214 | */ |
bpatel@766 | 215 | public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) { |
duke@1 | 216 | } |
duke@1 | 217 | |
duke@1 | 218 | /** |
duke@1 | 219 | * {@inheritDoc} |
duke@1 | 220 | */ |
bpatel@766 | 221 | protected void addSummaryLink(int context, ClassDoc cd, ProgramElementDoc member, |
bpatel@766 | 222 | Content tdSummary) { |
bpatel@766 | 223 | Content strong = HtmlTree.STRONG(new RawHtml( |
bpatel@766 | 224 | writer.getDocLink(context, (MemberDoc) member, member.name(), false))); |
bpatel@766 | 225 | Content code = HtmlTree.CODE(strong); |
bpatel@766 | 226 | tdSummary.addContent(code); |
bpatel@766 | 227 | } |
bpatel@766 | 228 | |
bpatel@766 | 229 | /** |
bpatel@766 | 230 | * {@inheritDoc} |
bpatel@766 | 231 | */ |
bpatel@766 | 232 | protected void addInheritedSummaryLink(ClassDoc cd, |
bpatel@766 | 233 | ProgramElementDoc member, Content linksTree) { |
duke@1 | 234 | //Not applicable. |
duke@1 | 235 | } |
duke@1 | 236 | |
duke@1 | 237 | /** |
duke@1 | 238 | * {@inheritDoc} |
duke@1 | 239 | */ |
bpatel@766 | 240 | protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) { |
duke@1 | 241 | MemberDoc m = (MemberDoc)member; |
bpatel@766 | 242 | addModifierAndType(m, getType(m), tdSummaryType); |
duke@1 | 243 | } |
duke@1 | 244 | |
duke@1 | 245 | /** |
duke@1 | 246 | * {@inheritDoc} |
duke@1 | 247 | */ |
bpatel@766 | 248 | protected Content getDeprecatedLink(ProgramElementDoc member) { |
bpatel@766 | 249 | return writer.getDocLink(LinkInfoImpl.CONTEXT_MEMBER, |
bpatel@766 | 250 | (MemberDoc) member, ((MemberDoc)member).qualifiedName()); |
duke@1 | 251 | } |
duke@1 | 252 | |
duke@1 | 253 | /** |
duke@1 | 254 | * {@inheritDoc} |
duke@1 | 255 | */ |
bpatel@766 | 256 | protected Content getNavSummaryLink(ClassDoc cd, boolean link) { |
duke@1 | 257 | if (link) { |
bpatel@766 | 258 | return writer.getHyperLink("", "annotation_type_required_element_summary", |
bpatel@766 | 259 | writer.getResource("doclet.navAnnotationTypeRequiredMember")); |
duke@1 | 260 | } else { |
bpatel@766 | 261 | return writer.getResource("doclet.navAnnotationTypeRequiredMember"); |
duke@1 | 262 | } |
duke@1 | 263 | } |
duke@1 | 264 | |
duke@1 | 265 | /** |
duke@1 | 266 | * {@inheritDoc} |
duke@1 | 267 | */ |
bpatel@766 | 268 | protected void addNavDetailLink(boolean link, Content liNav) { |
duke@1 | 269 | if (link) { |
bpatel@766 | 270 | liNav.addContent(writer.getHyperLink("", "annotation_type_element_detail", |
bpatel@766 | 271 | writer.getResource("doclet.navAnnotationTypeMember"))); |
duke@1 | 272 | } else { |
bpatel@766 | 273 | liNav.addContent(writer.getResource("doclet.navAnnotationTypeMember")); |
duke@1 | 274 | } |
duke@1 | 275 | } |
duke@1 | 276 | |
duke@1 | 277 | private Type getType(MemberDoc member) { |
duke@1 | 278 | if (member instanceof FieldDoc) { |
duke@1 | 279 | return ((FieldDoc) member).type(); |
duke@1 | 280 | } else { |
duke@1 | 281 | return ((MethodDoc) member).returnType(); |
duke@1 | 282 | } |
duke@1 | 283 | } |
duke@1 | 284 | } |