Thu, 15 Nov 2012 19:54:20 -0800
8002079: update DocFile to use a JavaFileManager
Reviewed-by: darcy
duke@1 | 1 | /* |
bpatel@1350 | 2 | * Copyright (c) 1998, 2012, 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 | |
duke@1 | 28 | import java.io.*; |
duke@1 | 29 | import java.util.*; |
jjg@1357 | 30 | |
bpatel@766 | 31 | import com.sun.javadoc.*; |
bpatel@766 | 32 | import com.sun.tools.doclets.formats.html.markup.*; |
bpatel@766 | 33 | import com.sun.tools.doclets.internal.toolkit.*; |
jjg@1357 | 34 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 35 | |
duke@1 | 36 | /** |
duke@1 | 37 | * Generate class usage information. |
duke@1 | 38 | * |
jjg@1359 | 39 | * <p><b>This is NOT part of any supported API. |
jjg@1359 | 40 | * If you write code that depends on this, you do so at your own risk. |
jjg@1359 | 41 | * This code and its internal interfaces are subject to change or |
jjg@1359 | 42 | * deletion without notice.</b> |
jjg@1359 | 43 | * |
duke@1 | 44 | * @author Robert G. Field |
bpatel@243 | 45 | * @author Bhavesh Patel (Modified) |
duke@1 | 46 | */ |
duke@1 | 47 | public class ClassUseWriter extends SubWriterHolderWriter { |
duke@1 | 48 | |
duke@1 | 49 | final ClassDoc classdoc; |
mcimadamore@184 | 50 | Set<PackageDoc> pkgToPackageAnnotations = null; |
jjg@74 | 51 | final Map<String,List<ProgramElementDoc>> pkgToClassTypeParameter; |
jjg@74 | 52 | final Map<String,List<ProgramElementDoc>> pkgToClassAnnotations; |
jjg@74 | 53 | final Map<String,List<ProgramElementDoc>> pkgToMethodTypeParameter; |
jjg@74 | 54 | final Map<String,List<ProgramElementDoc>> pkgToMethodArgTypeParameter; |
jjg@74 | 55 | final Map<String,List<ProgramElementDoc>> pkgToMethodReturnTypeParameter; |
jjg@74 | 56 | final Map<String,List<ProgramElementDoc>> pkgToMethodAnnotations; |
jjg@74 | 57 | final Map<String,List<ProgramElementDoc>> pkgToMethodParameterAnnotations; |
jjg@74 | 58 | final Map<String,List<ProgramElementDoc>> pkgToFieldTypeParameter; |
jjg@74 | 59 | final Map<String,List<ProgramElementDoc>> pkgToFieldAnnotations; |
jjg@74 | 60 | final Map<String,List<ProgramElementDoc>> pkgToSubclass; |
jjg@74 | 61 | final Map<String,List<ProgramElementDoc>> pkgToSubinterface; |
jjg@74 | 62 | final Map<String,List<ProgramElementDoc>> pkgToImplementingClass; |
jjg@74 | 63 | final Map<String,List<ProgramElementDoc>> pkgToField; |
jjg@74 | 64 | final Map<String,List<ProgramElementDoc>> pkgToMethodReturn; |
jjg@74 | 65 | final Map<String,List<ProgramElementDoc>> pkgToMethodArgs; |
jjg@74 | 66 | final Map<String,List<ProgramElementDoc>> pkgToMethodThrows; |
jjg@74 | 67 | final Map<String,List<ProgramElementDoc>> pkgToConstructorAnnotations; |
jjg@74 | 68 | final Map<String,List<ProgramElementDoc>> pkgToConstructorParameterAnnotations; |
jjg@74 | 69 | final Map<String,List<ProgramElementDoc>> pkgToConstructorArgs; |
jjg@74 | 70 | final Map<String,List<ProgramElementDoc>> pkgToConstructorArgTypeParameter; |
jjg@74 | 71 | final Map<String,List<ProgramElementDoc>> pkgToConstructorThrows; |
jjg@74 | 72 | final SortedSet<PackageDoc> pkgSet; |
duke@1 | 73 | final MethodWriterImpl methodSubWriter; |
duke@1 | 74 | final ConstructorWriterImpl constrSubWriter; |
duke@1 | 75 | final FieldWriterImpl fieldSubWriter; |
duke@1 | 76 | final NestedClassWriterImpl classSubWriter; |
bpatel@243 | 77 | // Summary for various use tables. |
bpatel@243 | 78 | final String classUseTableSummary; |
bpatel@243 | 79 | final String subclassUseTableSummary; |
bpatel@243 | 80 | final String subinterfaceUseTableSummary; |
bpatel@243 | 81 | final String fieldUseTableSummary; |
bpatel@243 | 82 | final String methodUseTableSummary; |
bpatel@243 | 83 | final String constructorUseTableSummary; |
duke@1 | 84 | |
duke@1 | 85 | /** |
duke@1 | 86 | * Constructor. |
duke@1 | 87 | * |
duke@1 | 88 | * @param filename the file to be generated. |
duke@1 | 89 | * @throws IOException |
duke@1 | 90 | * @throws DocletAbortException |
duke@1 | 91 | */ |
duke@1 | 92 | public ClassUseWriter(ConfigurationImpl configuration, |
jjg@1372 | 93 | ClassUseMapper mapper, DocPath filename, |
duke@1 | 94 | ClassDoc classdoc) throws IOException { |
jjg@1372 | 95 | super(configuration, filename); |
duke@1 | 96 | this.classdoc = classdoc; |
duke@1 | 97 | if (mapper.classToPackageAnnotations.containsKey(classdoc.qualifiedName())) |
jjg@74 | 98 | pkgToPackageAnnotations = new HashSet<PackageDoc>(mapper.classToPackageAnnotations.get(classdoc.qualifiedName())); |
duke@1 | 99 | configuration.currentcd = classdoc; |
jjg@74 | 100 | this.pkgSet = new TreeSet<PackageDoc>(); |
duke@1 | 101 | this.pkgToClassTypeParameter = pkgDivide(mapper.classToClassTypeParam); |
duke@1 | 102 | this.pkgToClassAnnotations = pkgDivide(mapper.classToClassAnnotations); |
duke@1 | 103 | this.pkgToMethodTypeParameter = pkgDivide(mapper.classToExecMemberDocTypeParam); |
duke@1 | 104 | this.pkgToMethodArgTypeParameter = pkgDivide(mapper.classToExecMemberDocArgTypeParam); |
duke@1 | 105 | this.pkgToFieldTypeParameter = pkgDivide(mapper.classToFieldDocTypeParam); |
duke@1 | 106 | this.pkgToFieldAnnotations = pkgDivide(mapper.annotationToFieldDoc); |
duke@1 | 107 | this.pkgToMethodReturnTypeParameter = pkgDivide(mapper.classToExecMemberDocReturnTypeParam); |
duke@1 | 108 | this.pkgToMethodAnnotations = pkgDivide(mapper.classToExecMemberDocAnnotations); |
duke@1 | 109 | this.pkgToMethodParameterAnnotations = pkgDivide(mapper.classToExecMemberDocParamAnnotation); |
duke@1 | 110 | this.pkgToSubclass = pkgDivide(mapper.classToSubclass); |
duke@1 | 111 | this.pkgToSubinterface = pkgDivide(mapper.classToSubinterface); |
duke@1 | 112 | this.pkgToImplementingClass = pkgDivide(mapper.classToImplementingClass); |
duke@1 | 113 | this.pkgToField = pkgDivide(mapper.classToField); |
duke@1 | 114 | this.pkgToMethodReturn = pkgDivide(mapper.classToMethodReturn); |
duke@1 | 115 | this.pkgToMethodArgs = pkgDivide(mapper.classToMethodArgs); |
duke@1 | 116 | this.pkgToMethodThrows = pkgDivide(mapper.classToMethodThrows); |
duke@1 | 117 | this.pkgToConstructorAnnotations = pkgDivide(mapper.classToConstructorAnnotations); |
duke@1 | 118 | this.pkgToConstructorParameterAnnotations = pkgDivide(mapper.classToConstructorParamAnnotation); |
duke@1 | 119 | this.pkgToConstructorArgs = pkgDivide(mapper.classToConstructorArgs); |
duke@1 | 120 | this.pkgToConstructorArgTypeParameter = pkgDivide(mapper.classToConstructorDocArgTypeParam); |
duke@1 | 121 | this.pkgToConstructorThrows = pkgDivide(mapper.classToConstructorThrows); |
duke@1 | 122 | //tmp test |
duke@1 | 123 | if (pkgSet.size() > 0 && |
duke@1 | 124 | mapper.classToPackage.containsKey(classdoc.qualifiedName()) && |
duke@1 | 125 | !pkgSet.equals(mapper.classToPackage.get(classdoc.qualifiedName()))) { |
duke@1 | 126 | configuration.root.printWarning("Internal error: package sets don't match: " + pkgSet + " with: " + |
duke@1 | 127 | mapper.classToPackage.get(classdoc.qualifiedName())); |
duke@1 | 128 | } |
duke@1 | 129 | methodSubWriter = new MethodWriterImpl(this); |
duke@1 | 130 | constrSubWriter = new ConstructorWriterImpl(this); |
duke@1 | 131 | fieldSubWriter = new FieldWriterImpl(this); |
duke@1 | 132 | classSubWriter = new NestedClassWriterImpl(this); |
bpatel@243 | 133 | classUseTableSummary = configuration.getText("doclet.Use_Table_Summary", |
bpatel@243 | 134 | configuration.getText("doclet.classes")); |
bpatel@243 | 135 | subclassUseTableSummary = configuration.getText("doclet.Use_Table_Summary", |
bpatel@243 | 136 | configuration.getText("doclet.subclasses")); |
bpatel@243 | 137 | subinterfaceUseTableSummary = configuration.getText("doclet.Use_Table_Summary", |
bpatel@243 | 138 | configuration.getText("doclet.subinterfaces")); |
bpatel@243 | 139 | fieldUseTableSummary = configuration.getText("doclet.Use_Table_Summary", |
bpatel@243 | 140 | configuration.getText("doclet.fields")); |
bpatel@243 | 141 | methodUseTableSummary = configuration.getText("doclet.Use_Table_Summary", |
bpatel@243 | 142 | configuration.getText("doclet.methods")); |
bpatel@243 | 143 | constructorUseTableSummary = configuration.getText("doclet.Use_Table_Summary", |
bpatel@243 | 144 | configuration.getText("doclet.constructors")); |
duke@1 | 145 | } |
duke@1 | 146 | |
duke@1 | 147 | /** |
duke@1 | 148 | * Write out class use pages. |
duke@1 | 149 | * @throws DocletAbortException |
duke@1 | 150 | */ |
duke@1 | 151 | public static void generate(ConfigurationImpl configuration, |
duke@1 | 152 | ClassTree classtree) { |
duke@1 | 153 | ClassUseMapper mapper = new ClassUseMapper(configuration.root, classtree); |
duke@1 | 154 | ClassDoc[] classes = configuration.root.classes(); |
duke@1 | 155 | for (int i = 0; i < classes.length; i++) { |
bpatel@995 | 156 | // If -nodeprecated option is set and the containing package is marked |
bpatel@995 | 157 | // as deprecated, do not generate the class-use page. We will still generate |
bpatel@995 | 158 | // the class-use page if the class is marked as deprecated but the containing |
bpatel@995 | 159 | // package is not since it could still be linked from that package-use page. |
bpatel@995 | 160 | if (!(configuration.nodeprecated && |
bpatel@995 | 161 | Util.isDeprecated(classes[i].containingPackage()))) |
bpatel@995 | 162 | ClassUseWriter.generate(configuration, mapper, classes[i]); |
duke@1 | 163 | } |
duke@1 | 164 | PackageDoc[] pkgs = configuration.packages; |
duke@1 | 165 | for (int i = 0; i < pkgs.length; i++) { |
bpatel@995 | 166 | // If -nodeprecated option is set and the package is marked |
bpatel@995 | 167 | // as deprecated, do not generate the package-use page. |
bpatel@995 | 168 | if (!(configuration.nodeprecated && Util.isDeprecated(pkgs[i]))) |
bpatel@995 | 169 | PackageUseWriter.generate(configuration, mapper, pkgs[i]); |
duke@1 | 170 | } |
duke@1 | 171 | } |
duke@1 | 172 | |
jjg@74 | 173 | private Map<String,List<ProgramElementDoc>> pkgDivide(Map<String,? extends List<? extends ProgramElementDoc>> classMap) { |
jjg@74 | 174 | Map<String,List<ProgramElementDoc>> map = new HashMap<String,List<ProgramElementDoc>>(); |
jjg@74 | 175 | List<? extends ProgramElementDoc> list= classMap.get(classdoc.qualifiedName()); |
duke@1 | 176 | if (list != null) { |
duke@1 | 177 | Collections.sort(list); |
jjg@74 | 178 | Iterator<? extends ProgramElementDoc> it = list.iterator(); |
duke@1 | 179 | while (it.hasNext()) { |
jjg@74 | 180 | ProgramElementDoc doc = it.next(); |
duke@1 | 181 | PackageDoc pkg = doc.containingPackage(); |
duke@1 | 182 | pkgSet.add(pkg); |
jjg@74 | 183 | List<ProgramElementDoc> inPkg = map.get(pkg.name()); |
duke@1 | 184 | if (inPkg == null) { |
jjg@74 | 185 | inPkg = new ArrayList<ProgramElementDoc>(); |
duke@1 | 186 | map.put(pkg.name(), inPkg); |
duke@1 | 187 | } |
duke@1 | 188 | inPkg.add(doc); |
duke@1 | 189 | } |
duke@1 | 190 | } |
duke@1 | 191 | return map; |
duke@1 | 192 | } |
duke@1 | 193 | |
duke@1 | 194 | /** |
duke@1 | 195 | * Generate a class page. |
duke@1 | 196 | */ |
duke@1 | 197 | public static void generate(ConfigurationImpl configuration, |
duke@1 | 198 | ClassUseMapper mapper, ClassDoc classdoc) { |
duke@1 | 199 | ClassUseWriter clsgen; |
jjg@1372 | 200 | DocPath path = DocPath.forPackage(classdoc) |
jjg@1372 | 201 | .resolve(DocPaths.CLASS_USE) |
jjg@1372 | 202 | .resolve(DocPath.forName(classdoc)); |
duke@1 | 203 | try { |
duke@1 | 204 | clsgen = new ClassUseWriter(configuration, |
jjg@1372 | 205 | mapper, path, |
jjg@1372 | 206 | classdoc); |
duke@1 | 207 | clsgen.generateClassUseFile(); |
duke@1 | 208 | clsgen.close(); |
duke@1 | 209 | } catch (IOException exc) { |
duke@1 | 210 | configuration.standardmessage. |
duke@1 | 211 | error("doclet.exception_encountered", |
jjg@1372 | 212 | exc.toString(), path.getPath()); |
duke@1 | 213 | throw new DocletAbortException(); |
duke@1 | 214 | } |
duke@1 | 215 | } |
duke@1 | 216 | |
duke@1 | 217 | /** |
bpatel@766 | 218 | * Generate the class use list. |
duke@1 | 219 | */ |
duke@1 | 220 | protected void generateClassUseFile() throws IOException { |
bpatel@766 | 221 | Content body = getClassUseHeader(); |
bpatel@766 | 222 | HtmlTree div = new HtmlTree(HtmlTag.DIV); |
bpatel@766 | 223 | div.addStyle(HtmlStyle.classUseContainer); |
duke@1 | 224 | if (pkgSet.size() > 0) { |
bpatel@766 | 225 | addClassUse(div); |
duke@1 | 226 | } else { |
bpatel@766 | 227 | div.addContent(getResource("doclet.ClassUse_No.usage.of.0", |
bpatel@766 | 228 | classdoc.qualifiedName())); |
duke@1 | 229 | } |
bpatel@766 | 230 | body.addContent(div); |
bpatel@766 | 231 | addNavLinks(false, body); |
bpatel@766 | 232 | addBottom(body); |
bpatel@766 | 233 | printHtmlDocument(null, true, body); |
duke@1 | 234 | } |
duke@1 | 235 | |
duke@1 | 236 | /** |
bpatel@766 | 237 | * Add the class use documentation. |
bpatel@766 | 238 | * |
bpatel@766 | 239 | * @param contentTree the content tree to which the class use information will be added |
duke@1 | 240 | */ |
bpatel@766 | 241 | protected void addClassUse(Content contentTree) throws IOException { |
bpatel@766 | 242 | HtmlTree ul = new HtmlTree(HtmlTag.UL); |
bpatel@766 | 243 | ul.addStyle(HtmlStyle.blockList); |
bpatel@766 | 244 | if (configuration.packages.length > 1) { |
bpatel@766 | 245 | addPackageList(ul); |
bpatel@766 | 246 | addPackageAnnotationList(ul); |
bpatel@766 | 247 | } |
bpatel@766 | 248 | addClassList(ul); |
bpatel@766 | 249 | contentTree.addContent(ul); |
duke@1 | 250 | } |
duke@1 | 251 | |
duke@1 | 252 | /** |
bpatel@766 | 253 | * Add the packages list that use the given class. |
bpatel@766 | 254 | * |
bpatel@766 | 255 | * @param contentTree the content tree to which the packages list will be added |
duke@1 | 256 | */ |
bpatel@766 | 257 | protected void addPackageList(Content contentTree) throws IOException { |
bpatel@766 | 258 | Content table = HtmlTree.TABLE(0, 3, 0, useTableSummary, |
jjg@1410 | 259 | getTableCaption(configuration.getText( |
bpatel@766 | 260 | "doclet.ClassUse_Packages.that.use.0", |
jjg@1410 | 261 | getLink(new LinkInfoImpl(configuration, LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc, |
bpatel@766 | 262 | false))))); |
bpatel@766 | 263 | table.addContent(getSummaryTableHeader(packageTableHeader, "col")); |
bpatel@766 | 264 | Content tbody = new HtmlTree(HtmlTag.TBODY); |
bpatel@766 | 265 | Iterator<PackageDoc> it = pkgSet.iterator(); |
bpatel@766 | 266 | for (int i = 0; it.hasNext(); i++) { |
bpatel@766 | 267 | PackageDoc pkg = it.next(); |
bpatel@766 | 268 | HtmlTree tr = new HtmlTree(HtmlTag.TR); |
bpatel@766 | 269 | if (i % 2 == 0) { |
bpatel@766 | 270 | tr.addStyle(HtmlStyle.altColor); |
bpatel@766 | 271 | } else { |
bpatel@766 | 272 | tr.addStyle(HtmlStyle.rowColor); |
bpatel@766 | 273 | } |
bpatel@766 | 274 | addPackageUse(pkg, tr); |
bpatel@766 | 275 | tbody.addContent(tr); |
bpatel@766 | 276 | } |
bpatel@766 | 277 | table.addContent(tbody); |
bpatel@766 | 278 | Content li = HtmlTree.LI(HtmlStyle.blockList, table); |
bpatel@766 | 279 | contentTree.addContent(li); |
duke@1 | 280 | } |
duke@1 | 281 | |
duke@1 | 282 | /** |
bpatel@766 | 283 | * Add the package annotation list. |
bpatel@766 | 284 | * |
bpatel@766 | 285 | * @param contentTree the content tree to which the package annotation list will be added |
duke@1 | 286 | */ |
bpatel@766 | 287 | protected void addPackageAnnotationList(Content contentTree) throws IOException { |
bpatel@766 | 288 | if ((!classdoc.isAnnotationType()) || |
bpatel@766 | 289 | pkgToPackageAnnotations == null || |
jjg@1410 | 290 | pkgToPackageAnnotations.isEmpty()) { |
bpatel@766 | 291 | return; |
bpatel@766 | 292 | } |
bpatel@766 | 293 | Content table = HtmlTree.TABLE(0, 3, 0, useTableSummary, |
jjg@1410 | 294 | getTableCaption(configuration.getText( |
bpatel@766 | 295 | "doclet.ClassUse_PackageAnnotation", |
jjg@1410 | 296 | getLink(new LinkInfoImpl(configuration, |
jjg@1410 | 297 | LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc, false))))); |
bpatel@766 | 298 | table.addContent(getSummaryTableHeader(packageTableHeader, "col")); |
bpatel@766 | 299 | Content tbody = new HtmlTree(HtmlTag.TBODY); |
bpatel@766 | 300 | Iterator<PackageDoc> it = pkgToPackageAnnotations.iterator(); |
bpatel@766 | 301 | for (int i = 0; it.hasNext(); i++) { |
bpatel@766 | 302 | PackageDoc pkg = it.next(); |
bpatel@766 | 303 | HtmlTree tr = new HtmlTree(HtmlTag.TR); |
bpatel@766 | 304 | if (i % 2 == 0) { |
bpatel@766 | 305 | tr.addStyle(HtmlStyle.altColor); |
bpatel@766 | 306 | } else { |
bpatel@766 | 307 | tr.addStyle(HtmlStyle.rowColor); |
bpatel@766 | 308 | } |
bpatel@766 | 309 | Content tdFirst = HtmlTree.TD(HtmlStyle.colFirst, |
bpatel@766 | 310 | getPackageLink(pkg, new StringContent(pkg.name()))); |
bpatel@766 | 311 | tr.addContent(tdFirst); |
bpatel@766 | 312 | HtmlTree tdLast = new HtmlTree(HtmlTag.TD); |
bpatel@766 | 313 | tdLast.addStyle(HtmlStyle.colLast); |
bpatel@927 | 314 | addSummaryComment(pkg, tdLast); |
bpatel@766 | 315 | tr.addContent(tdLast); |
bpatel@766 | 316 | tbody.addContent(tr); |
bpatel@766 | 317 | } |
bpatel@766 | 318 | table.addContent(tbody); |
bpatel@766 | 319 | Content li = HtmlTree.LI(HtmlStyle.blockList, table); |
bpatel@766 | 320 | contentTree.addContent(li); |
duke@1 | 321 | } |
duke@1 | 322 | |
duke@1 | 323 | /** |
bpatel@766 | 324 | * Add the class list that use the given class. |
bpatel@766 | 325 | * |
bpatel@766 | 326 | * @param contentTree the content tree to which the class list will be added |
duke@1 | 327 | */ |
bpatel@766 | 328 | protected void addClassList(Content contentTree) throws IOException { |
bpatel@766 | 329 | HtmlTree ul = new HtmlTree(HtmlTag.UL); |
bpatel@766 | 330 | ul.addStyle(HtmlStyle.blockList); |
bpatel@766 | 331 | for (Iterator<PackageDoc> it = pkgSet.iterator(); it.hasNext();) { |
bpatel@766 | 332 | PackageDoc pkg = it.next(); |
bpatel@766 | 333 | Content li = HtmlTree.LI(HtmlStyle.blockList, getMarkerAnchor(pkg.name())); |
bpatel@766 | 334 | Content link = new RawHtml( |
bpatel@766 | 335 | configuration.getText("doclet.ClassUse_Uses.of.0.in.1", |
jjg@1410 | 336 | getLink(new LinkInfoImpl(configuration, LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, |
bpatel@766 | 337 | classdoc, false)), |
bpatel@766 | 338 | getPackageLinkString(pkg, Util.getPackageName(pkg), false))); |
bpatel@766 | 339 | Content heading = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING, link); |
bpatel@766 | 340 | li.addContent(heading); |
bpatel@766 | 341 | addClassUse(pkg, li); |
bpatel@766 | 342 | ul.addContent(li); |
bpatel@766 | 343 | } |
bpatel@766 | 344 | Content li = HtmlTree.LI(HtmlStyle.blockList, ul); |
bpatel@766 | 345 | contentTree.addContent(li); |
duke@1 | 346 | } |
duke@1 | 347 | |
duke@1 | 348 | /** |
bpatel@766 | 349 | * Add the package use information. |
bpatel@766 | 350 | * |
bpatel@766 | 351 | * @param pkg the package that uses the given class |
bpatel@766 | 352 | * @param contentTree the content tree to which the package use information will be added |
duke@1 | 353 | */ |
bpatel@766 | 354 | protected void addPackageUse(PackageDoc pkg, Content contentTree) throws IOException { |
bpatel@766 | 355 | Content tdFirst = HtmlTree.TD(HtmlStyle.colFirst, |
jjg@1372 | 356 | getHyperLink(pkg.name(), new StringContent(Util.getPackageName(pkg)))); |
bpatel@766 | 357 | contentTree.addContent(tdFirst); |
bpatel@766 | 358 | HtmlTree tdLast = new HtmlTree(HtmlTag.TD); |
bpatel@766 | 359 | tdLast.addStyle(HtmlStyle.colLast); |
bpatel@927 | 360 | addSummaryComment(pkg, tdLast); |
bpatel@766 | 361 | contentTree.addContent(tdLast); |
duke@1 | 362 | } |
duke@1 | 363 | |
duke@1 | 364 | /** |
bpatel@766 | 365 | * Add the class use information. |
bpatel@766 | 366 | * |
bpatel@766 | 367 | * @param pkg the package that uses the given class |
bpatel@766 | 368 | * @param contentTree the content tree to which the class use information will be added |
duke@1 | 369 | */ |
bpatel@766 | 370 | protected void addClassUse(PackageDoc pkg, Content contentTree) throws IOException { |
jjg@1410 | 371 | String classLink = getLink(new LinkInfoImpl(configuration, |
bpatel@766 | 372 | LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc, false)); |
bpatel@766 | 373 | String pkgLink = getPackageLinkString(pkg, Util.getPackageName(pkg), false); |
bpatel@766 | 374 | classSubWriter.addUseInfo(pkgToClassAnnotations.get(pkg.name()), |
bpatel@766 | 375 | configuration.getText("doclet.ClassUse_Annotation", classLink, |
bpatel@766 | 376 | pkgLink), classUseTableSummary, contentTree); |
bpatel@766 | 377 | classSubWriter.addUseInfo(pkgToClassTypeParameter.get(pkg.name()), |
bpatel@766 | 378 | configuration.getText("doclet.ClassUse_TypeParameter", classLink, |
bpatel@766 | 379 | pkgLink), classUseTableSummary, contentTree); |
bpatel@766 | 380 | classSubWriter.addUseInfo(pkgToSubclass.get(pkg.name()), |
bpatel@766 | 381 | configuration.getText("doclet.ClassUse_Subclass", classLink, |
bpatel@766 | 382 | pkgLink), subclassUseTableSummary, contentTree); |
bpatel@766 | 383 | classSubWriter.addUseInfo(pkgToSubinterface.get(pkg.name()), |
bpatel@766 | 384 | configuration.getText("doclet.ClassUse_Subinterface", classLink, |
bpatel@766 | 385 | pkgLink), subinterfaceUseTableSummary, contentTree); |
bpatel@766 | 386 | classSubWriter.addUseInfo(pkgToImplementingClass.get(pkg.name()), |
bpatel@766 | 387 | configuration.getText("doclet.ClassUse_ImplementingClass", classLink, |
bpatel@766 | 388 | pkgLink), classUseTableSummary, contentTree); |
bpatel@766 | 389 | fieldSubWriter.addUseInfo(pkgToField.get(pkg.name()), |
bpatel@766 | 390 | configuration.getText("doclet.ClassUse_Field", classLink, |
bpatel@766 | 391 | pkgLink), fieldUseTableSummary, contentTree); |
bpatel@766 | 392 | fieldSubWriter.addUseInfo(pkgToFieldAnnotations.get(pkg.name()), |
bpatel@766 | 393 | configuration.getText("doclet.ClassUse_FieldAnnotations", classLink, |
bpatel@766 | 394 | pkgLink), fieldUseTableSummary, contentTree); |
bpatel@766 | 395 | fieldSubWriter.addUseInfo(pkgToFieldTypeParameter.get(pkg.name()), |
bpatel@766 | 396 | configuration.getText("doclet.ClassUse_FieldTypeParameter", classLink, |
bpatel@766 | 397 | pkgLink), fieldUseTableSummary, contentTree); |
bpatel@766 | 398 | methodSubWriter.addUseInfo(pkgToMethodAnnotations.get(pkg.name()), |
bpatel@766 | 399 | configuration.getText("doclet.ClassUse_MethodAnnotations", classLink, |
bpatel@766 | 400 | pkgLink), methodUseTableSummary, contentTree); |
bpatel@766 | 401 | methodSubWriter.addUseInfo(pkgToMethodParameterAnnotations.get(pkg.name()), |
bpatel@766 | 402 | configuration.getText("doclet.ClassUse_MethodParameterAnnotations", classLink, |
bpatel@766 | 403 | pkgLink), methodUseTableSummary, contentTree); |
bpatel@766 | 404 | methodSubWriter.addUseInfo(pkgToMethodTypeParameter.get(pkg.name()), |
bpatel@766 | 405 | configuration.getText("doclet.ClassUse_MethodTypeParameter", classLink, |
bpatel@766 | 406 | pkgLink), methodUseTableSummary, contentTree); |
bpatel@766 | 407 | methodSubWriter.addUseInfo(pkgToMethodReturn.get(pkg.name()), |
bpatel@766 | 408 | configuration.getText("doclet.ClassUse_MethodReturn", classLink, |
bpatel@766 | 409 | pkgLink), methodUseTableSummary, contentTree); |
bpatel@766 | 410 | methodSubWriter.addUseInfo(pkgToMethodReturnTypeParameter.get(pkg.name()), |
bpatel@766 | 411 | configuration.getText("doclet.ClassUse_MethodReturnTypeParameter", classLink, |
bpatel@766 | 412 | pkgLink), methodUseTableSummary, contentTree); |
bpatel@766 | 413 | methodSubWriter.addUseInfo(pkgToMethodArgs.get(pkg.name()), |
bpatel@766 | 414 | configuration.getText("doclet.ClassUse_MethodArgs", classLink, |
bpatel@766 | 415 | pkgLink), methodUseTableSummary, contentTree); |
bpatel@766 | 416 | methodSubWriter.addUseInfo(pkgToMethodArgTypeParameter.get(pkg.name()), |
bpatel@766 | 417 | configuration.getText("doclet.ClassUse_MethodArgsTypeParameters", classLink, |
bpatel@766 | 418 | pkgLink), methodUseTableSummary, contentTree); |
bpatel@766 | 419 | methodSubWriter.addUseInfo(pkgToMethodThrows.get(pkg.name()), |
bpatel@766 | 420 | configuration.getText("doclet.ClassUse_MethodThrows", classLink, |
bpatel@766 | 421 | pkgLink), methodUseTableSummary, contentTree); |
bpatel@766 | 422 | constrSubWriter.addUseInfo(pkgToConstructorAnnotations.get(pkg.name()), |
bpatel@766 | 423 | configuration.getText("doclet.ClassUse_ConstructorAnnotations", classLink, |
bpatel@766 | 424 | pkgLink), constructorUseTableSummary, contentTree); |
bpatel@766 | 425 | constrSubWriter.addUseInfo(pkgToConstructorParameterAnnotations.get(pkg.name()), |
bpatel@766 | 426 | configuration.getText("doclet.ClassUse_ConstructorParameterAnnotations", classLink, |
bpatel@766 | 427 | pkgLink), constructorUseTableSummary, contentTree); |
bpatel@766 | 428 | constrSubWriter.addUseInfo(pkgToConstructorArgs.get(pkg.name()), |
bpatel@766 | 429 | configuration.getText("doclet.ClassUse_ConstructorArgs", classLink, |
bpatel@766 | 430 | pkgLink), constructorUseTableSummary, contentTree); |
bpatel@766 | 431 | constrSubWriter.addUseInfo(pkgToConstructorArgTypeParameter.get(pkg.name()), |
bpatel@766 | 432 | configuration.getText("doclet.ClassUse_ConstructorArgsTypeParameters", classLink, |
bpatel@766 | 433 | pkgLink), constructorUseTableSummary, contentTree); |
bpatel@766 | 434 | constrSubWriter.addUseInfo(pkgToConstructorThrows.get(pkg.name()), |
bpatel@766 | 435 | configuration.getText("doclet.ClassUse_ConstructorThrows", classLink, |
bpatel@766 | 436 | pkgLink), constructorUseTableSummary, contentTree); |
duke@1 | 437 | } |
duke@1 | 438 | |
bpatel@766 | 439 | /** |
bpatel@766 | 440 | * Get the header for the class use Listing. |
bpatel@766 | 441 | * |
bpatel@766 | 442 | * @return a content tree representing the class use header |
bpatel@766 | 443 | */ |
bpatel@766 | 444 | protected Content getClassUseHeader() { |
bpatel@766 | 445 | String cltype = configuration.getText(classdoc.isInterface()? |
bpatel@766 | 446 | "doclet.Interface":"doclet.Class"); |
bpatel@766 | 447 | String clname = classdoc.qualifiedName(); |
bpatel@766 | 448 | String title = configuration.getText("doclet.Window_ClassUse_Header", |
bpatel@766 | 449 | cltype, clname); |
bpatel@766 | 450 | Content bodyTree = getBody(true, getWindowTitle(title)); |
bpatel@766 | 451 | addTop(bodyTree); |
bpatel@766 | 452 | addNavLinks(true, bodyTree); |
bpatel@766 | 453 | Content headContent = getResource("doclet.ClassUse_Title", cltype, clname); |
bpatel@766 | 454 | Content heading = HtmlTree.HEADING(HtmlConstants.CLASS_PAGE_HEADING, |
bpatel@766 | 455 | true, HtmlStyle.title, headContent); |
bpatel@766 | 456 | Content div = HtmlTree.DIV(HtmlStyle.header, heading); |
bpatel@766 | 457 | bodyTree.addContent(div); |
bpatel@766 | 458 | return bodyTree; |
duke@1 | 459 | } |
duke@1 | 460 | |
bpatel@766 | 461 | /** |
bpatel@766 | 462 | * Get this package link. |
bpatel@766 | 463 | * |
bpatel@766 | 464 | * @return a content tree for the package link |
bpatel@766 | 465 | */ |
bpatel@766 | 466 | protected Content getNavLinkPackage() { |
jjg@1372 | 467 | Content linkContent = |
jjg@1373 | 468 | getHyperLink(DocPath.parent.resolve(DocPaths.PACKAGE_SUMMARY), packageLabel); |
bpatel@766 | 469 | Content li = HtmlTree.LI(linkContent); |
bpatel@766 | 470 | return li; |
bpatel@766 | 471 | } |
bpatel@766 | 472 | |
bpatel@766 | 473 | /** |
bpatel@766 | 474 | * Get class page link. |
bpatel@766 | 475 | * |
bpatel@766 | 476 | * @return a content tree for the class page link |
bpatel@766 | 477 | */ |
bpatel@766 | 478 | protected Content getNavLinkClass() { |
bpatel@766 | 479 | Content linkContent = new RawHtml(getLink(new LinkInfoImpl( |
jjg@1410 | 480 | configuration, LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc, |
jjg@1410 | 481 | "", configuration.getText("doclet.Class"), false))); |
bpatel@766 | 482 | Content li = HtmlTree.LI(linkContent); |
bpatel@766 | 483 | return li; |
bpatel@766 | 484 | } |
bpatel@766 | 485 | |
bpatel@766 | 486 | /** |
bpatel@766 | 487 | * Get the use link. |
bpatel@766 | 488 | * |
bpatel@766 | 489 | * @return a content tree for the use link |
bpatel@766 | 490 | */ |
bpatel@766 | 491 | protected Content getNavLinkClassUse() { |
bpatel@766 | 492 | Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, useLabel); |
bpatel@766 | 493 | return li; |
bpatel@766 | 494 | } |
bpatel@766 | 495 | |
bpatel@766 | 496 | /** |
bpatel@766 | 497 | * Get the tree link. |
bpatel@766 | 498 | * |
bpatel@766 | 499 | * @return a content tree for the tree link |
bpatel@766 | 500 | */ |
bpatel@766 | 501 | protected Content getNavLinkTree() { |
bpatel@766 | 502 | Content linkContent = classdoc.containingPackage().isIncluded() ? |
jjg@1373 | 503 | getHyperLink(DocPath.parent.resolve(DocPaths.PACKAGE_TREE), treeLabel) : |
jjg@1373 | 504 | getHyperLink(pathToRoot.resolve(DocPaths.OVERVIEW_TREE), treeLabel); |
bpatel@766 | 505 | Content li = HtmlTree.LI(linkContent); |
bpatel@766 | 506 | return li; |
bpatel@766 | 507 | } |
duke@1 | 508 | } |