Sat, 01 Dec 2007 00:00:00 +0000
Initial load
duke@1 | 1 | /* |
duke@1 | 2 | * Copyright 1997-2006 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.javadoc; |
duke@1 | 27 | |
duke@1 | 28 | import java.util.*; |
duke@1 | 29 | |
duke@1 | 30 | import com.sun.javadoc.*; |
duke@1 | 31 | |
duke@1 | 32 | import static com.sun.javadoc.LanguageVersion.*; |
duke@1 | 33 | |
duke@1 | 34 | import com.sun.tools.javac.util.List; |
duke@1 | 35 | import com.sun.tools.javac.util.ListBuffer; |
duke@1 | 36 | import com.sun.tools.javac.util.Name; |
duke@1 | 37 | import com.sun.tools.javac.util.Position; |
duke@1 | 38 | |
duke@1 | 39 | import com.sun.tools.javac.code.Flags; |
duke@1 | 40 | import com.sun.tools.javac.code.Kinds; |
duke@1 | 41 | import com.sun.tools.javac.code.TypeTags; |
duke@1 | 42 | import com.sun.tools.javac.code.Type; |
duke@1 | 43 | import com.sun.tools.javac.code.Types; |
duke@1 | 44 | import com.sun.tools.javac.code.Type.ClassType; |
duke@1 | 45 | import com.sun.tools.javac.code.Scope; |
duke@1 | 46 | import com.sun.tools.javac.code.Symbol; |
duke@1 | 47 | import com.sun.tools.javac.code.Symbol.*; |
duke@1 | 48 | |
duke@1 | 49 | import com.sun.tools.javac.comp.AttrContext; |
duke@1 | 50 | import com.sun.tools.javac.comp.Env; |
duke@1 | 51 | |
duke@1 | 52 | import com.sun.tools.javac.tree.JCTree; |
duke@1 | 53 | import com.sun.tools.javac.tree.JCTree.JCFieldAccess; |
duke@1 | 54 | import com.sun.tools.javac.tree.JCTree.JCImport; |
duke@1 | 55 | import com.sun.tools.javac.tree.JCTree.JCClassDecl; |
duke@1 | 56 | import com.sun.tools.javac.tree.TreeInfo; |
duke@1 | 57 | |
duke@1 | 58 | import static com.sun.tools.javac.code.Flags.*; |
duke@1 | 59 | import static com.sun.tools.javac.code.Kinds.*; |
duke@1 | 60 | import static com.sun.tools.javac.code.TypeTags.*; |
duke@1 | 61 | |
duke@1 | 62 | import java.io.File; |
duke@1 | 63 | import java.util.Set; |
duke@1 | 64 | import java.util.HashSet; |
duke@1 | 65 | import java.lang.reflect.Modifier; |
duke@1 | 66 | |
duke@1 | 67 | /** |
duke@1 | 68 | * Represents a java class and provides access to information |
duke@1 | 69 | * about the class, the class' comment and tags, and the |
duke@1 | 70 | * members of the class. A ClassDocImpl only exists if it was |
duke@1 | 71 | * processed in this run of javadoc. References to classes |
duke@1 | 72 | * which may or may not have been processed in this run are |
duke@1 | 73 | * referred to using Type (which can be converted to ClassDocImpl, |
duke@1 | 74 | * if possible). |
duke@1 | 75 | * |
duke@1 | 76 | * @see Type |
duke@1 | 77 | * |
duke@1 | 78 | * @since 1.2 |
duke@1 | 79 | * @author Robert Field |
duke@1 | 80 | * @author Neal Gafter (rewrite) |
duke@1 | 81 | * @author Scott Seligman (generics, enums, annotations) |
duke@1 | 82 | */ |
duke@1 | 83 | |
duke@1 | 84 | public class ClassDocImpl extends ProgramElementDocImpl implements ClassDoc { |
duke@1 | 85 | |
duke@1 | 86 | public final ClassType type; // protected->public for debugging |
duke@1 | 87 | protected final ClassSymbol tsym; |
duke@1 | 88 | |
duke@1 | 89 | boolean isIncluded = false; // Set in RootDocImpl |
duke@1 | 90 | |
duke@1 | 91 | private SerializedForm serializedForm; |
duke@1 | 92 | |
duke@1 | 93 | /** |
duke@1 | 94 | * Constructor |
duke@1 | 95 | */ |
duke@1 | 96 | public ClassDocImpl(DocEnv env, ClassSymbol sym) { |
duke@1 | 97 | this(env, sym, null, null, null); |
duke@1 | 98 | } |
duke@1 | 99 | |
duke@1 | 100 | /** |
duke@1 | 101 | * Constructor |
duke@1 | 102 | */ |
duke@1 | 103 | public ClassDocImpl(DocEnv env, ClassSymbol sym, String documentation, |
duke@1 | 104 | JCClassDecl tree, Position.LineMap lineMap) { |
duke@1 | 105 | super(env, sym, documentation, tree, lineMap); |
duke@1 | 106 | this.type = (ClassType)sym.type; |
duke@1 | 107 | this.tsym = sym; |
duke@1 | 108 | } |
duke@1 | 109 | |
duke@1 | 110 | /** |
duke@1 | 111 | * Returns the flags in terms of javac's flags |
duke@1 | 112 | */ |
duke@1 | 113 | protected long getFlags() { |
duke@1 | 114 | return getFlags(tsym); |
duke@1 | 115 | } |
duke@1 | 116 | |
duke@1 | 117 | /** |
duke@1 | 118 | * Returns the flags of a ClassSymbol in terms of javac's flags |
duke@1 | 119 | */ |
duke@1 | 120 | static long getFlags(ClassSymbol clazz) { |
duke@1 | 121 | while (true) { |
duke@1 | 122 | try { |
duke@1 | 123 | return clazz.flags(); |
duke@1 | 124 | } catch (CompletionFailure ex) { |
duke@1 | 125 | // quietly ignore completion failures |
duke@1 | 126 | } |
duke@1 | 127 | } |
duke@1 | 128 | } |
duke@1 | 129 | |
duke@1 | 130 | /** |
duke@1 | 131 | * Is a ClassSymbol an annotation type? |
duke@1 | 132 | */ |
duke@1 | 133 | static boolean isAnnotationType(ClassSymbol clazz) { |
duke@1 | 134 | return (getFlags(clazz) & Flags.ANNOTATION) != 0; |
duke@1 | 135 | } |
duke@1 | 136 | |
duke@1 | 137 | /** |
duke@1 | 138 | * Identify the containing class |
duke@1 | 139 | */ |
duke@1 | 140 | protected ClassSymbol getContainingClass() { |
duke@1 | 141 | return tsym.owner.enclClass(); |
duke@1 | 142 | } |
duke@1 | 143 | |
duke@1 | 144 | /** |
duke@1 | 145 | * Return true if this is a class, not an interface. |
duke@1 | 146 | */ |
duke@1 | 147 | public boolean isClass() { |
duke@1 | 148 | return !Modifier.isInterface(getModifiers()); |
duke@1 | 149 | } |
duke@1 | 150 | |
duke@1 | 151 | /** |
duke@1 | 152 | * Return true if this is a ordinary class, |
duke@1 | 153 | * not an enumeration, exception, an error, or an interface. |
duke@1 | 154 | */ |
duke@1 | 155 | public boolean isOrdinaryClass() { |
duke@1 | 156 | if (isEnum() || isInterface() || isAnnotationType()) { |
duke@1 | 157 | return false; |
duke@1 | 158 | } |
duke@1 | 159 | for (Type t = type; t.tag == TypeTags.CLASS; t = env.types.supertype(t)) { |
duke@1 | 160 | if (t.tsym == env.syms.errorType.tsym || |
duke@1 | 161 | t.tsym == env.syms.exceptionType.tsym) { |
duke@1 | 162 | return false; |
duke@1 | 163 | } |
duke@1 | 164 | } |
duke@1 | 165 | return true; |
duke@1 | 166 | } |
duke@1 | 167 | |
duke@1 | 168 | /** |
duke@1 | 169 | * Return true if this is an enumeration. |
duke@1 | 170 | * (For legacy doclets, return false.) |
duke@1 | 171 | */ |
duke@1 | 172 | public boolean isEnum() { |
duke@1 | 173 | return (getFlags() & Flags.ENUM) != 0 |
duke@1 | 174 | && |
duke@1 | 175 | !env.legacyDoclet; |
duke@1 | 176 | } |
duke@1 | 177 | |
duke@1 | 178 | /** |
duke@1 | 179 | * Return true if this is an interface, but not an annotation type. |
duke@1 | 180 | * Overridden by AnnotationTypeDocImpl. |
duke@1 | 181 | */ |
duke@1 | 182 | public boolean isInterface() { |
duke@1 | 183 | return Modifier.isInterface(getModifiers()); |
duke@1 | 184 | } |
duke@1 | 185 | |
duke@1 | 186 | /** |
duke@1 | 187 | * Return true if this is an exception class |
duke@1 | 188 | */ |
duke@1 | 189 | public boolean isException() { |
duke@1 | 190 | if (isEnum() || isInterface() || isAnnotationType()) { |
duke@1 | 191 | return false; |
duke@1 | 192 | } |
duke@1 | 193 | for (Type t = type; t.tag == TypeTags.CLASS; t = env.types.supertype(t)) { |
duke@1 | 194 | if (t.tsym == env.syms.exceptionType.tsym) { |
duke@1 | 195 | return true; |
duke@1 | 196 | } |
duke@1 | 197 | } |
duke@1 | 198 | return false; |
duke@1 | 199 | } |
duke@1 | 200 | |
duke@1 | 201 | /** |
duke@1 | 202 | * Return true if this is an error class |
duke@1 | 203 | */ |
duke@1 | 204 | public boolean isError() { |
duke@1 | 205 | if (isEnum() || isInterface() || isAnnotationType()) { |
duke@1 | 206 | return false; |
duke@1 | 207 | } |
duke@1 | 208 | for (Type t = type; t.tag == TypeTags.CLASS; t = env.types.supertype(t)) { |
duke@1 | 209 | if (t.tsym == env.syms.errorType.tsym) { |
duke@1 | 210 | return true; |
duke@1 | 211 | } |
duke@1 | 212 | } |
duke@1 | 213 | return false; |
duke@1 | 214 | } |
duke@1 | 215 | |
duke@1 | 216 | /** |
duke@1 | 217 | * Return true if this is a throwable class |
duke@1 | 218 | */ |
duke@1 | 219 | public boolean isThrowable() { |
duke@1 | 220 | if (isEnum() || isInterface() || isAnnotationType()) { |
duke@1 | 221 | return false; |
duke@1 | 222 | } |
duke@1 | 223 | for (Type t = type; t.tag == TypeTags.CLASS; t = env.types.supertype(t)) { |
duke@1 | 224 | if (t.tsym == env.syms.throwableType.tsym) { |
duke@1 | 225 | return true; |
duke@1 | 226 | } |
duke@1 | 227 | } |
duke@1 | 228 | return false; |
duke@1 | 229 | } |
duke@1 | 230 | |
duke@1 | 231 | /** |
duke@1 | 232 | * Return true if this class is abstract |
duke@1 | 233 | */ |
duke@1 | 234 | public boolean isAbstract() { |
duke@1 | 235 | return Modifier.isAbstract(getModifiers()); |
duke@1 | 236 | } |
duke@1 | 237 | |
duke@1 | 238 | /** |
duke@1 | 239 | * Returns true if this class was synthesized by the compiler. |
duke@1 | 240 | */ |
duke@1 | 241 | public boolean isSynthetic() { |
duke@1 | 242 | return (getFlags() & Flags.SYNTHETIC) != 0; |
duke@1 | 243 | } |
duke@1 | 244 | |
duke@1 | 245 | /** |
duke@1 | 246 | * Return true if this class is included in the active set. |
duke@1 | 247 | * A ClassDoc is included iff either it is specified on the |
duke@1 | 248 | * commandline, or if it's containing package is specified |
duke@1 | 249 | * on the command line, or if it is a member class of an |
duke@1 | 250 | * included class. |
duke@1 | 251 | */ |
duke@1 | 252 | |
duke@1 | 253 | public boolean isIncluded() { |
duke@1 | 254 | if (isIncluded) { |
duke@1 | 255 | return true; |
duke@1 | 256 | } |
duke@1 | 257 | if (env.shouldDocument(tsym)) { |
duke@1 | 258 | // Class is nameable from top-level and |
duke@1 | 259 | // the class and all enclosing classes |
duke@1 | 260 | // pass the modifier filter. |
duke@1 | 261 | if (containingPackage().isIncluded()) { |
duke@1 | 262 | return isIncluded=true; |
duke@1 | 263 | } |
duke@1 | 264 | ClassDoc outer = containingClass(); |
duke@1 | 265 | if (outer != null && outer.isIncluded()) { |
duke@1 | 266 | return isIncluded=true; |
duke@1 | 267 | } |
duke@1 | 268 | } |
duke@1 | 269 | return false; |
duke@1 | 270 | } |
duke@1 | 271 | |
duke@1 | 272 | /** |
duke@1 | 273 | * Return the package that this class is contained in. |
duke@1 | 274 | */ |
duke@1 | 275 | public PackageDoc containingPackage() { |
duke@1 | 276 | PackageDocImpl p = env.getPackageDoc(tsym.packge()); |
duke@1 | 277 | SourcePosition po = position(); |
duke@1 | 278 | if (po != null && p.setDocPath == false && p.zipDocPath == null) { |
duke@1 | 279 | //Set the package path if possible |
duke@1 | 280 | File packageDir = po.file().getParentFile(); |
duke@1 | 281 | if (packageDir != null |
duke@1 | 282 | && (new File(packageDir, "package.html")).exists()) { |
duke@1 | 283 | p.setDocPath(packageDir.getPath()); |
duke@1 | 284 | } else { |
duke@1 | 285 | p.setDocPath(null); |
duke@1 | 286 | } |
duke@1 | 287 | } |
duke@1 | 288 | return p; |
duke@1 | 289 | } |
duke@1 | 290 | |
duke@1 | 291 | /** |
duke@1 | 292 | * Return the class name without package qualifier - but with |
duke@1 | 293 | * enclosing class qualifier - as a String. |
duke@1 | 294 | * <pre> |
duke@1 | 295 | * Examples: |
duke@1 | 296 | * for java.util.Hashtable |
duke@1 | 297 | * return Hashtable |
duke@1 | 298 | * for java.util.Map.Entry |
duke@1 | 299 | * return Map.Entry |
duke@1 | 300 | * </pre> |
duke@1 | 301 | */ |
duke@1 | 302 | public String name() { |
duke@1 | 303 | return getClassName(tsym, false); |
duke@1 | 304 | } |
duke@1 | 305 | |
duke@1 | 306 | /** |
duke@1 | 307 | * Return the qualified class name as a String. |
duke@1 | 308 | * <pre> |
duke@1 | 309 | * Example: |
duke@1 | 310 | * for java.util.Hashtable |
duke@1 | 311 | * return java.util.Hashtable |
duke@1 | 312 | * if no qualifier, just return flat name |
duke@1 | 313 | * </pre> |
duke@1 | 314 | */ |
duke@1 | 315 | public String qualifiedName() { |
duke@1 | 316 | return getClassName(tsym, true); |
duke@1 | 317 | } |
duke@1 | 318 | |
duke@1 | 319 | /** |
duke@1 | 320 | * Return unqualified name of type excluding any dimension information. |
duke@1 | 321 | * <p> |
duke@1 | 322 | * For example, a two dimensional array of String returns 'String'. |
duke@1 | 323 | */ |
duke@1 | 324 | public String typeName() { |
duke@1 | 325 | return name(); |
duke@1 | 326 | } |
duke@1 | 327 | |
duke@1 | 328 | /** |
duke@1 | 329 | * Return qualified name of type excluding any dimension information. |
duke@1 | 330 | *<p> |
duke@1 | 331 | * For example, a two dimensional array of String |
duke@1 | 332 | * returns 'java.lang.String'. |
duke@1 | 333 | */ |
duke@1 | 334 | public String qualifiedTypeName() { |
duke@1 | 335 | return qualifiedName(); |
duke@1 | 336 | } |
duke@1 | 337 | |
duke@1 | 338 | /** |
duke@1 | 339 | * Return the simple name of this type. |
duke@1 | 340 | */ |
duke@1 | 341 | public String simpleTypeName() { |
duke@1 | 342 | return tsym.name.toString(); |
duke@1 | 343 | } |
duke@1 | 344 | |
duke@1 | 345 | /** |
duke@1 | 346 | * Return the qualified name and any type parameters. |
duke@1 | 347 | * Each parameter is a type variable with optional bounds. |
duke@1 | 348 | */ |
duke@1 | 349 | public String toString() { |
duke@1 | 350 | return classToString(env, tsym, true); |
duke@1 | 351 | } |
duke@1 | 352 | |
duke@1 | 353 | /** |
duke@1 | 354 | * Return the class name as a string. If "full" is true the name is |
duke@1 | 355 | * qualified, otherwise it is qualified by its enclosing class(es) only. |
duke@1 | 356 | */ |
duke@1 | 357 | static String getClassName(ClassSymbol c, boolean full) { |
duke@1 | 358 | if (full) { |
duke@1 | 359 | return c.getQualifiedName().toString(); |
duke@1 | 360 | } else { |
duke@1 | 361 | String n = ""; |
duke@1 | 362 | for ( ; c != null; c = c.owner.enclClass()) { |
duke@1 | 363 | n = c.name + (n.equals("") ? "" : ".") + n; |
duke@1 | 364 | } |
duke@1 | 365 | return n; |
duke@1 | 366 | } |
duke@1 | 367 | } |
duke@1 | 368 | |
duke@1 | 369 | /** |
duke@1 | 370 | * Return the class name with any type parameters as a string. |
duke@1 | 371 | * Each parameter is a type variable with optional bounds. |
duke@1 | 372 | * If "full" is true all names are qualified, otherwise they are |
duke@1 | 373 | * qualified by their enclosing class(es) only. |
duke@1 | 374 | */ |
duke@1 | 375 | static String classToString(DocEnv env, ClassSymbol c, boolean full) { |
duke@1 | 376 | StringBuffer s = new StringBuffer(); |
duke@1 | 377 | if (!c.isInner()) { // if c is not an inner class |
duke@1 | 378 | s.append(getClassName(c, full)); |
duke@1 | 379 | } else { |
duke@1 | 380 | // c is an inner class, so include type params of outer. |
duke@1 | 381 | ClassSymbol encl = c.owner.enclClass(); |
duke@1 | 382 | s.append(classToString(env, encl, full)) |
duke@1 | 383 | .append('.') |
duke@1 | 384 | .append(c.name); |
duke@1 | 385 | } |
duke@1 | 386 | s.append(TypeMaker.typeParametersString(env, c, full)); |
duke@1 | 387 | return s.toString(); |
duke@1 | 388 | } |
duke@1 | 389 | |
duke@1 | 390 | /** |
duke@1 | 391 | * Is this class (or any enclosing class) generic? That is, does |
duke@1 | 392 | * it have type parameters? |
duke@1 | 393 | */ |
duke@1 | 394 | static boolean isGeneric(ClassSymbol c) { |
duke@1 | 395 | return c.type.allparams().nonEmpty(); |
duke@1 | 396 | } |
duke@1 | 397 | |
duke@1 | 398 | /** |
duke@1 | 399 | * Return the formal type parameters of this class or interface. |
duke@1 | 400 | * Return an empty array if there are none. |
duke@1 | 401 | */ |
duke@1 | 402 | public TypeVariable[] typeParameters() { |
duke@1 | 403 | if (env.legacyDoclet) { |
duke@1 | 404 | return new TypeVariable[0]; |
duke@1 | 405 | } |
duke@1 | 406 | TypeVariable res[] = new TypeVariable[type.getTypeArguments().length()]; |
duke@1 | 407 | TypeMaker.getTypes(env, type.getTypeArguments(), res); |
duke@1 | 408 | return res; |
duke@1 | 409 | } |
duke@1 | 410 | |
duke@1 | 411 | /** |
duke@1 | 412 | * Return the type parameter tags of this class or interface. |
duke@1 | 413 | */ |
duke@1 | 414 | public ParamTag[] typeParamTags() { |
duke@1 | 415 | return (env.legacyDoclet) |
duke@1 | 416 | ? new ParamTag[0] |
duke@1 | 417 | : comment().typeParamTags(); |
duke@1 | 418 | } |
duke@1 | 419 | |
duke@1 | 420 | /** |
duke@1 | 421 | * Return the modifier string for this class. If it's an interface |
duke@1 | 422 | * exclude 'abstract' keyword from the modifier string |
duke@1 | 423 | */ |
duke@1 | 424 | public String modifiers() { |
duke@1 | 425 | return Modifier.toString(modifierSpecifier()); |
duke@1 | 426 | } |
duke@1 | 427 | |
duke@1 | 428 | public int modifierSpecifier() { |
duke@1 | 429 | int modifiers = getModifiers(); |
duke@1 | 430 | return (isInterface() || isAnnotationType()) |
duke@1 | 431 | ? modifiers & ~Modifier.ABSTRACT |
duke@1 | 432 | : modifiers; |
duke@1 | 433 | } |
duke@1 | 434 | |
duke@1 | 435 | /** |
duke@1 | 436 | * Return the superclass of this class |
duke@1 | 437 | * |
duke@1 | 438 | * @return the ClassDocImpl for the superclass of this class, null |
duke@1 | 439 | * if there is no superclass. |
duke@1 | 440 | */ |
duke@1 | 441 | public ClassDoc superclass() { |
duke@1 | 442 | if (isInterface() || isAnnotationType()) return null; |
duke@1 | 443 | if (tsym == env.syms.objectType.tsym) return null; |
duke@1 | 444 | ClassSymbol c = (ClassSymbol)env.types.supertype(type).tsym; |
duke@1 | 445 | if (c == null || c == tsym) c = (ClassSymbol)env.syms.objectType.tsym; |
duke@1 | 446 | return env.getClassDoc(c); |
duke@1 | 447 | } |
duke@1 | 448 | |
duke@1 | 449 | /** |
duke@1 | 450 | * Return the superclass of this class. Return null if this is an |
duke@1 | 451 | * interface. A superclass is represented by either a |
duke@1 | 452 | * <code>ClassDoc</code> or a <code>ParameterizedType</code>. |
duke@1 | 453 | */ |
duke@1 | 454 | public com.sun.javadoc.Type superclassType() { |
duke@1 | 455 | if (isInterface() || isAnnotationType() || |
duke@1 | 456 | (tsym == env.syms.objectType.tsym)) |
duke@1 | 457 | return null; |
duke@1 | 458 | Type sup = env.types.supertype(type); |
duke@1 | 459 | return TypeMaker.getType(env, |
duke@1 | 460 | (sup != type) ? sup : env.syms.objectType); |
duke@1 | 461 | } |
duke@1 | 462 | |
duke@1 | 463 | /** |
duke@1 | 464 | * Test whether this class is a subclass of the specified class. |
duke@1 | 465 | * |
duke@1 | 466 | * @param cd the candidate superclass. |
duke@1 | 467 | * @return true if cd is a superclass of this class. |
duke@1 | 468 | */ |
duke@1 | 469 | public boolean subclassOf(ClassDoc cd) { |
duke@1 | 470 | return tsym.isSubClass(((ClassDocImpl)cd).tsym, env.types); |
duke@1 | 471 | } |
duke@1 | 472 | |
duke@1 | 473 | /** |
duke@1 | 474 | * Return interfaces implemented by this class or interfaces |
duke@1 | 475 | * extended by this interface. |
duke@1 | 476 | * |
duke@1 | 477 | * @return An array of ClassDocImpl representing the interfaces. |
duke@1 | 478 | * Return an empty array if there are no interfaces. |
duke@1 | 479 | */ |
duke@1 | 480 | public ClassDoc[] interfaces() { |
duke@1 | 481 | ListBuffer<ClassDocImpl> ta = new ListBuffer<ClassDocImpl>(); |
duke@1 | 482 | for (Type t : env.types.interfaces(type)) { |
duke@1 | 483 | ta.append(env.getClassDoc((ClassSymbol)t.tsym)); |
duke@1 | 484 | } |
duke@1 | 485 | //### Cache ta here? |
duke@1 | 486 | return ta.toArray(new ClassDocImpl[ta.length()]); |
duke@1 | 487 | } |
duke@1 | 488 | |
duke@1 | 489 | /** |
duke@1 | 490 | * Return interfaces implemented by this class or interfaces extended |
duke@1 | 491 | * by this interface. Includes only directly-declared interfaces, not |
duke@1 | 492 | * inherited interfaces. |
duke@1 | 493 | * Return an empty array if there are no interfaces. |
duke@1 | 494 | */ |
duke@1 | 495 | public com.sun.javadoc.Type[] interfaceTypes() { |
duke@1 | 496 | //### Cache result here? |
duke@1 | 497 | return TypeMaker.getTypes(env, env.types.interfaces(type)); |
duke@1 | 498 | } |
duke@1 | 499 | |
duke@1 | 500 | /** |
duke@1 | 501 | * Return fields in class. |
duke@1 | 502 | * @param filter include only the included fields if filter==true |
duke@1 | 503 | */ |
duke@1 | 504 | public FieldDoc[] fields(boolean filter) { |
duke@1 | 505 | return fields(filter, false); |
duke@1 | 506 | } |
duke@1 | 507 | |
duke@1 | 508 | /** |
duke@1 | 509 | * Return included fields in class. |
duke@1 | 510 | */ |
duke@1 | 511 | public FieldDoc[] fields() { |
duke@1 | 512 | return fields(true, false); |
duke@1 | 513 | } |
duke@1 | 514 | |
duke@1 | 515 | /** |
duke@1 | 516 | * Return the enum constants if this is an enum type. |
duke@1 | 517 | */ |
duke@1 | 518 | public FieldDoc[] enumConstants() { |
duke@1 | 519 | return fields(false, true); |
duke@1 | 520 | } |
duke@1 | 521 | |
duke@1 | 522 | /** |
duke@1 | 523 | * Return fields in class. |
duke@1 | 524 | * @param filter if true, return only the included fields |
duke@1 | 525 | * @param enumConstants if true, return the enum constants instead |
duke@1 | 526 | */ |
duke@1 | 527 | private FieldDoc[] fields(boolean filter, boolean enumConstants) { |
duke@1 | 528 | List<FieldDocImpl> fields = List.nil(); |
duke@1 | 529 | for (Scope.Entry e = tsym.members().elems; e != null; e = e.sibling) { |
duke@1 | 530 | if (e.sym != null && e.sym.kind == VAR) { |
duke@1 | 531 | VarSymbol s = (VarSymbol)e.sym; |
duke@1 | 532 | boolean isEnum = ((s.flags() & Flags.ENUM) != 0) && |
duke@1 | 533 | !env.legacyDoclet; |
duke@1 | 534 | if (isEnum == enumConstants && |
duke@1 | 535 | (!filter || env.shouldDocument(s))) { |
duke@1 | 536 | fields = fields.prepend(env.getFieldDoc(s)); |
duke@1 | 537 | } |
duke@1 | 538 | } |
duke@1 | 539 | } |
duke@1 | 540 | return fields.toArray(new FieldDocImpl[fields.length()]); |
duke@1 | 541 | } |
duke@1 | 542 | |
duke@1 | 543 | /** |
duke@1 | 544 | * Return methods in class. |
duke@1 | 545 | * This method is overridden by AnnotationTypeDocImpl. |
duke@1 | 546 | * |
duke@1 | 547 | * @param filter include only the included methods if filter==true |
duke@1 | 548 | * @return an array of MethodDocImpl for representing the visible |
duke@1 | 549 | * methods in this class. Does not include constructors. |
duke@1 | 550 | */ |
duke@1 | 551 | public MethodDoc[] methods(boolean filter) { |
duke@1 | 552 | Name.Table names = tsym.name.table; |
duke@1 | 553 | List<MethodDocImpl> methods = List.nil(); |
duke@1 | 554 | for (Scope.Entry e = tsym.members().elems; e != null; e = e.sibling) { |
duke@1 | 555 | if (e.sym != null && |
duke@1 | 556 | e.sym.kind == Kinds.MTH && e.sym.name != names.init) { |
duke@1 | 557 | MethodSymbol s = (MethodSymbol)e.sym; |
duke@1 | 558 | if (!filter || env.shouldDocument(s)) { |
duke@1 | 559 | methods = methods.prepend(env.getMethodDoc(s)); |
duke@1 | 560 | } |
duke@1 | 561 | } |
duke@1 | 562 | } |
duke@1 | 563 | //### Cache methods here? |
duke@1 | 564 | return methods.toArray(new MethodDocImpl[methods.length()]); |
duke@1 | 565 | } |
duke@1 | 566 | |
duke@1 | 567 | /** |
duke@1 | 568 | * Return included methods in class. |
duke@1 | 569 | * |
duke@1 | 570 | * @return an array of MethodDocImpl for representing the visible |
duke@1 | 571 | * methods in this class. Does not include constructors. |
duke@1 | 572 | */ |
duke@1 | 573 | public MethodDoc[] methods() { |
duke@1 | 574 | return methods(true); |
duke@1 | 575 | } |
duke@1 | 576 | |
duke@1 | 577 | /** |
duke@1 | 578 | * Return constructors in class. |
duke@1 | 579 | * |
duke@1 | 580 | * @param filter include only the included constructors if filter==true |
duke@1 | 581 | * @return an array of ConstructorDocImpl for representing the visible |
duke@1 | 582 | * constructors in this class. |
duke@1 | 583 | */ |
duke@1 | 584 | public ConstructorDoc[] constructors(boolean filter) { |
duke@1 | 585 | Name.Table names = tsym.name.table; |
duke@1 | 586 | List<ConstructorDocImpl> constructors = List.nil(); |
duke@1 | 587 | for (Scope.Entry e = tsym.members().elems; e != null; e = e.sibling) { |
duke@1 | 588 | if (e.sym != null && |
duke@1 | 589 | e.sym.kind == Kinds.MTH && e.sym.name == names.init) { |
duke@1 | 590 | MethodSymbol s = (MethodSymbol)e.sym; |
duke@1 | 591 | if (!filter || env.shouldDocument(s)) { |
duke@1 | 592 | constructors = constructors.prepend(env.getConstructorDoc(s)); |
duke@1 | 593 | } |
duke@1 | 594 | } |
duke@1 | 595 | } |
duke@1 | 596 | //### Cache constructors here? |
duke@1 | 597 | return constructors.toArray(new ConstructorDocImpl[constructors.length()]); |
duke@1 | 598 | } |
duke@1 | 599 | |
duke@1 | 600 | /** |
duke@1 | 601 | * Return included constructors in class. |
duke@1 | 602 | * |
duke@1 | 603 | * @return an array of ConstructorDocImpl for representing the visible |
duke@1 | 604 | * constructors in this class. |
duke@1 | 605 | */ |
duke@1 | 606 | public ConstructorDoc[] constructors() { |
duke@1 | 607 | return constructors(true); |
duke@1 | 608 | } |
duke@1 | 609 | |
duke@1 | 610 | /** |
duke@1 | 611 | * Adds all inner classes of this class, and their |
duke@1 | 612 | * inner classes recursively, to the list l. |
duke@1 | 613 | */ |
duke@1 | 614 | void addAllClasses(ListBuffer<ClassDocImpl> l, boolean filtered) { |
duke@1 | 615 | try { |
duke@1 | 616 | if (isSynthetic()) return; |
duke@1 | 617 | // sometimes synthetic classes are not marked synthetic |
duke@1 | 618 | if (!JavadocTool.isValidClassName(tsym.name.toString())) return; |
duke@1 | 619 | if (filtered && !env.shouldDocument(tsym)) return; |
duke@1 | 620 | if (l.contains(this)) return; |
duke@1 | 621 | l.append(this); |
duke@1 | 622 | List<ClassDocImpl> more = List.nil(); |
duke@1 | 623 | for (Scope.Entry e = tsym.members().elems; e != null; |
duke@1 | 624 | e = e.sibling) { |
duke@1 | 625 | if (e.sym != null && e.sym.kind == Kinds.TYP) { |
duke@1 | 626 | ClassSymbol s = (ClassSymbol)e.sym; |
duke@1 | 627 | ClassDocImpl c = env.getClassDoc(s); |
duke@1 | 628 | if (c.isSynthetic()) continue; |
duke@1 | 629 | if (c != null) more = more.prepend(c); |
duke@1 | 630 | } |
duke@1 | 631 | } |
duke@1 | 632 | // this extra step preserves the ordering from oldjavadoc |
duke@1 | 633 | for (; more.nonEmpty(); more=more.tail) { |
duke@1 | 634 | more.head.addAllClasses(l, filtered); |
duke@1 | 635 | } |
duke@1 | 636 | } catch (CompletionFailure e) { |
duke@1 | 637 | // quietly ignore completion failures |
duke@1 | 638 | } |
duke@1 | 639 | } |
duke@1 | 640 | |
duke@1 | 641 | /** |
duke@1 | 642 | * Return inner classes within this class. |
duke@1 | 643 | * |
duke@1 | 644 | * @param filter include only the included inner classes if filter==true. |
duke@1 | 645 | * @return an array of ClassDocImpl for representing the visible |
duke@1 | 646 | * classes defined in this class. Anonymous and local classes |
duke@1 | 647 | * are not included. |
duke@1 | 648 | */ |
duke@1 | 649 | public ClassDoc[] innerClasses(boolean filter) { |
duke@1 | 650 | ListBuffer<ClassDocImpl> innerClasses = new ListBuffer<ClassDocImpl>(); |
duke@1 | 651 | for (Scope.Entry e = tsym.members().elems; e != null; e = e.sibling) { |
duke@1 | 652 | if (e.sym != null && e.sym.kind == Kinds.TYP) { |
duke@1 | 653 | ClassSymbol s = (ClassSymbol)e.sym; |
duke@1 | 654 | if ((s.flags_field & Flags.SYNTHETIC) != 0) continue; |
duke@1 | 655 | if (!filter || env.isVisible(s)) { |
duke@1 | 656 | innerClasses.prepend(env.getClassDoc(s)); |
duke@1 | 657 | } |
duke@1 | 658 | } |
duke@1 | 659 | } |
duke@1 | 660 | //### Cache classes here? |
duke@1 | 661 | return innerClasses.toArray(new ClassDocImpl[innerClasses.length()]); |
duke@1 | 662 | } |
duke@1 | 663 | |
duke@1 | 664 | /** |
duke@1 | 665 | * Return included inner classes within this class. |
duke@1 | 666 | * |
duke@1 | 667 | * @return an array of ClassDocImpl for representing the visible |
duke@1 | 668 | * classes defined in this class. Anonymous and local classes |
duke@1 | 669 | * are not included. |
duke@1 | 670 | */ |
duke@1 | 671 | public ClassDoc[] innerClasses() { |
duke@1 | 672 | return innerClasses(true); |
duke@1 | 673 | } |
duke@1 | 674 | |
duke@1 | 675 | /** |
duke@1 | 676 | * Find a class within the context of this class. |
duke@1 | 677 | * Search order: qualified name, in this class (inner), |
duke@1 | 678 | * in this package, in the class imports, in the package |
duke@1 | 679 | * imports. |
duke@1 | 680 | * Return the ClassDocImpl if found, null if not found. |
duke@1 | 681 | */ |
duke@1 | 682 | //### The specified search order is not the normal rule the |
duke@1 | 683 | //### compiler would use. Leave as specified or change it? |
duke@1 | 684 | public ClassDoc findClass(String className) { |
duke@1 | 685 | ClassDoc searchResult = searchClass(className); |
duke@1 | 686 | if (searchResult == null) { |
duke@1 | 687 | ClassDocImpl enclosingClass = (ClassDocImpl)containingClass(); |
duke@1 | 688 | //Expand search space to include enclosing class. |
duke@1 | 689 | while (enclosingClass != null && enclosingClass.containingClass() != null) { |
duke@1 | 690 | enclosingClass = (ClassDocImpl)enclosingClass.containingClass(); |
duke@1 | 691 | } |
duke@1 | 692 | searchResult = enclosingClass == null ? |
duke@1 | 693 | null : enclosingClass.searchClass(className); |
duke@1 | 694 | } |
duke@1 | 695 | return searchResult; |
duke@1 | 696 | } |
duke@1 | 697 | |
duke@1 | 698 | private ClassDoc searchClass(String className) { |
duke@1 | 699 | Name.Table names = tsym.name.table; |
duke@1 | 700 | |
duke@1 | 701 | // search by qualified name first |
duke@1 | 702 | ClassDoc cd = env.lookupClass(className); |
duke@1 | 703 | if (cd != null) { |
duke@1 | 704 | return cd; |
duke@1 | 705 | } |
duke@1 | 706 | |
duke@1 | 707 | // search inner classes |
duke@1 | 708 | //### Add private entry point to avoid creating array? |
duke@1 | 709 | //### Replicate code in innerClasses here to avoid consing? |
duke@1 | 710 | ClassDoc innerClasses[] = innerClasses(); |
duke@1 | 711 | for (int i = 0; i < innerClasses.length; i++) { |
duke@1 | 712 | if (innerClasses[i].name().equals(className) || |
duke@1 | 713 | //### This is from original javadoc but it looks suspicious to me... |
duke@1 | 714 | //### I believe it is attempting to compensate for the confused |
duke@1 | 715 | //### convention of including the nested class qualifiers in the |
duke@1 | 716 | //### 'name' of the inner class, rather than the true simple name. |
duke@1 | 717 | innerClasses[i].name().endsWith(className)) { |
duke@1 | 718 | return innerClasses[i]; |
duke@1 | 719 | } else { |
duke@1 | 720 | ClassDoc innercd = ((ClassDocImpl) innerClasses[i]).searchClass(className); |
duke@1 | 721 | if (innercd != null) { |
duke@1 | 722 | return innercd; |
duke@1 | 723 | } |
duke@1 | 724 | } |
duke@1 | 725 | } |
duke@1 | 726 | |
duke@1 | 727 | // check in this package |
duke@1 | 728 | cd = containingPackage().findClass(className); |
duke@1 | 729 | if (cd != null) { |
duke@1 | 730 | return cd; |
duke@1 | 731 | } |
duke@1 | 732 | |
duke@1 | 733 | // make sure that this symbol has been completed |
duke@1 | 734 | if (tsym.completer != null) { |
duke@1 | 735 | tsym.complete(); |
duke@1 | 736 | } |
duke@1 | 737 | |
duke@1 | 738 | // search imports |
duke@1 | 739 | |
duke@1 | 740 | if (tsym.sourcefile != null) { |
duke@1 | 741 | |
duke@1 | 742 | //### This information is available only for source classes. |
duke@1 | 743 | |
duke@1 | 744 | Env<AttrContext> compenv = env.enter.getEnv(tsym); |
duke@1 | 745 | if (compenv == null) return null; |
duke@1 | 746 | |
duke@1 | 747 | Scope s = compenv.toplevel.namedImportScope; |
duke@1 | 748 | for (Scope.Entry e = s.lookup(names.fromString(className)); e.scope != null; e = e.next()) { |
duke@1 | 749 | if (e.sym.kind == Kinds.TYP) { |
duke@1 | 750 | ClassDoc c = env.getClassDoc((ClassSymbol)e.sym); |
duke@1 | 751 | return c; |
duke@1 | 752 | } |
duke@1 | 753 | } |
duke@1 | 754 | |
duke@1 | 755 | s = compenv.toplevel.starImportScope; |
duke@1 | 756 | for (Scope.Entry e = s.lookup(names.fromString(className)); e.scope != null; e = e.next()) { |
duke@1 | 757 | if (e.sym.kind == Kinds.TYP) { |
duke@1 | 758 | ClassDoc c = env.getClassDoc((ClassSymbol)e.sym); |
duke@1 | 759 | return c; |
duke@1 | 760 | } |
duke@1 | 761 | } |
duke@1 | 762 | } |
duke@1 | 763 | |
duke@1 | 764 | return null; // not found |
duke@1 | 765 | } |
duke@1 | 766 | |
duke@1 | 767 | |
duke@1 | 768 | private boolean hasParameterTypes(MethodSymbol method, String[] argTypes) { |
duke@1 | 769 | |
duke@1 | 770 | if (argTypes == null) { |
duke@1 | 771 | // wildcard |
duke@1 | 772 | return true; |
duke@1 | 773 | } |
duke@1 | 774 | |
duke@1 | 775 | int i = 0; |
duke@1 | 776 | List<Type> types = method.type.getParameterTypes(); |
duke@1 | 777 | |
duke@1 | 778 | if (argTypes.length != types.length()) { |
duke@1 | 779 | return false; |
duke@1 | 780 | } |
duke@1 | 781 | |
duke@1 | 782 | for (Type t : types) { |
duke@1 | 783 | String argType = argTypes[i++]; |
duke@1 | 784 | // For vararg method, "T..." matches type T[]. |
duke@1 | 785 | if (i == argTypes.length) { |
duke@1 | 786 | argType = argType.replace("...", "[]"); |
duke@1 | 787 | } |
duke@1 | 788 | if (!hasTypeName(env.types.erasure(t), argType)) { //###(gj) |
duke@1 | 789 | return false; |
duke@1 | 790 | } |
duke@1 | 791 | } |
duke@1 | 792 | return true; |
duke@1 | 793 | } |
duke@1 | 794 | // where |
duke@1 | 795 | private boolean hasTypeName(Type t, String name) { |
duke@1 | 796 | return |
duke@1 | 797 | name.equals(TypeMaker.getTypeName(t, true)) |
duke@1 | 798 | || |
duke@1 | 799 | name.equals(TypeMaker.getTypeName(t, false)) |
duke@1 | 800 | || |
duke@1 | 801 | (qualifiedName() + "." + name).equals(TypeMaker.getTypeName(t, true)); |
duke@1 | 802 | } |
duke@1 | 803 | |
duke@1 | 804 | |
duke@1 | 805 | |
duke@1 | 806 | /** |
duke@1 | 807 | * Find a method in this class scope. |
duke@1 | 808 | * Search order: this class, interfaces, superclasses, outerclasses. |
duke@1 | 809 | * Note that this is not necessarily what the compiler would do! |
duke@1 | 810 | * |
duke@1 | 811 | * @param methodName the unqualified name to search for. |
duke@1 | 812 | * @param paramTypeArray the array of Strings for method parameter types. |
duke@1 | 813 | * @return the first MethodDocImpl which matches, null if not found. |
duke@1 | 814 | */ |
duke@1 | 815 | public MethodDocImpl findMethod(String methodName, String[] paramTypes) { |
duke@1 | 816 | // Use hash table 'searched' to avoid searching same class twice. |
duke@1 | 817 | //### It is not clear how this could happen. |
duke@1 | 818 | return searchMethod(methodName, paramTypes, new HashSet<ClassDocImpl>()); |
duke@1 | 819 | } |
duke@1 | 820 | |
duke@1 | 821 | private MethodDocImpl searchMethod(String methodName, |
duke@1 | 822 | String[] paramTypes, Set<ClassDocImpl> searched) { |
duke@1 | 823 | //### Note that this search is not necessarily what the compiler would do! |
duke@1 | 824 | |
duke@1 | 825 | ClassDocImpl cdi; |
duke@1 | 826 | MethodDocImpl mdi; |
duke@1 | 827 | |
duke@1 | 828 | if (searched.contains(this)) { |
duke@1 | 829 | return null; |
duke@1 | 830 | } |
duke@1 | 831 | searched.add(this); |
duke@1 | 832 | |
duke@1 | 833 | //DEBUG |
duke@1 | 834 | /*---------------------------------* |
duke@1 | 835 | System.out.print("searching " + this + " for " + methodName); |
duke@1 | 836 | if (paramTypes == null) { |
duke@1 | 837 | System.out.println("()"); |
duke@1 | 838 | } else { |
duke@1 | 839 | System.out.print("("); |
duke@1 | 840 | for (int k=0; k < paramTypes.length; k++) { |
duke@1 | 841 | System.out.print(paramTypes[k]); |
duke@1 | 842 | if ((k + 1) < paramTypes.length) { |
duke@1 | 843 | System.out.print(", "); |
duke@1 | 844 | } |
duke@1 | 845 | } |
duke@1 | 846 | System.out.println(")"); |
duke@1 | 847 | } |
duke@1 | 848 | *---------------------------------*/ |
duke@1 | 849 | |
duke@1 | 850 | // search current class |
duke@1 | 851 | Name.Table names = tsym.name.table; |
duke@1 | 852 | Scope.Entry e = tsym.members().lookup(names.fromString(methodName)); |
duke@1 | 853 | |
duke@1 | 854 | //### Using modifier filter here isn't really correct, |
duke@1 | 855 | //### but emulates the old behavior. Instead, we should |
duke@1 | 856 | //### apply the normal rules of visibility and inheritance. |
duke@1 | 857 | |
duke@1 | 858 | if (paramTypes == null) { |
duke@1 | 859 | // If no parameters specified, we are allowed to return |
duke@1 | 860 | // any method with a matching name. In practice, the old |
duke@1 | 861 | // code returned the first method, which is now the last! |
duke@1 | 862 | // In order to provide textually identical results, we |
duke@1 | 863 | // attempt to emulate the old behavior. |
duke@1 | 864 | MethodSymbol lastFound = null; |
duke@1 | 865 | for (; e.scope != null; e = e.next()) { |
duke@1 | 866 | if (e.sym.kind == Kinds.MTH) { |
duke@1 | 867 | //### Should intern methodName as Name. |
duke@1 | 868 | if (e.sym.name.toString().equals(methodName)) { |
duke@1 | 869 | lastFound = (MethodSymbol)e.sym; |
duke@1 | 870 | } |
duke@1 | 871 | } |
duke@1 | 872 | } |
duke@1 | 873 | if (lastFound != null) { |
duke@1 | 874 | return env.getMethodDoc(lastFound); |
duke@1 | 875 | } |
duke@1 | 876 | } else { |
duke@1 | 877 | for (; e.scope != null; e = e.next()) { |
duke@1 | 878 | if (e.sym != null && |
duke@1 | 879 | e.sym.kind == Kinds.MTH) { |
duke@1 | 880 | //### Should intern methodName as Name. |
duke@1 | 881 | if (hasParameterTypes((MethodSymbol)e.sym, paramTypes)) { |
duke@1 | 882 | return env.getMethodDoc((MethodSymbol)e.sym); |
duke@1 | 883 | } |
duke@1 | 884 | } |
duke@1 | 885 | } |
duke@1 | 886 | } |
duke@1 | 887 | |
duke@1 | 888 | //### If we found a MethodDoc above, but which did not pass |
duke@1 | 889 | //### the modifier filter, we should return failure here! |
duke@1 | 890 | |
duke@1 | 891 | // search superclass |
duke@1 | 892 | cdi = (ClassDocImpl)superclass(); |
duke@1 | 893 | if (cdi != null) { |
duke@1 | 894 | mdi = cdi.searchMethod(methodName, paramTypes, searched); |
duke@1 | 895 | if (mdi != null) { |
duke@1 | 896 | return mdi; |
duke@1 | 897 | } |
duke@1 | 898 | } |
duke@1 | 899 | |
duke@1 | 900 | // search interfaces |
duke@1 | 901 | ClassDoc intf[] = interfaces(); |
duke@1 | 902 | for (int i = 0; i < intf.length; i++) { |
duke@1 | 903 | cdi = (ClassDocImpl)intf[i]; |
duke@1 | 904 | mdi = cdi.searchMethod(methodName, paramTypes, searched); |
duke@1 | 905 | if (mdi != null) { |
duke@1 | 906 | return mdi; |
duke@1 | 907 | } |
duke@1 | 908 | } |
duke@1 | 909 | |
duke@1 | 910 | // search enclosing class |
duke@1 | 911 | cdi = (ClassDocImpl)containingClass(); |
duke@1 | 912 | if (cdi != null) { |
duke@1 | 913 | mdi = cdi.searchMethod(methodName, paramTypes, searched); |
duke@1 | 914 | if (mdi != null) { |
duke@1 | 915 | return mdi; |
duke@1 | 916 | } |
duke@1 | 917 | } |
duke@1 | 918 | |
duke@1 | 919 | //###(gj) As a temporary measure until type variables are better |
duke@1 | 920 | //### handled, try again without the parameter types. |
duke@1 | 921 | //### This should most often find the right method, and occassionally |
duke@1 | 922 | //### find the wrong one. |
duke@1 | 923 | //if (paramTypes != null) { |
duke@1 | 924 | // return findMethod(methodName, null); |
duke@1 | 925 | //} |
duke@1 | 926 | |
duke@1 | 927 | return null; |
duke@1 | 928 | } |
duke@1 | 929 | |
duke@1 | 930 | /** |
duke@1 | 931 | * Find constructor in this class. |
duke@1 | 932 | * |
duke@1 | 933 | * @param constrName the unqualified name to search for. |
duke@1 | 934 | * @param paramTypeArray the array of Strings for constructor parameters. |
duke@1 | 935 | * @return the first ConstructorDocImpl which matches, null if not found. |
duke@1 | 936 | */ |
duke@1 | 937 | public ConstructorDoc findConstructor(String constrName, |
duke@1 | 938 | String[] paramTypes) { |
duke@1 | 939 | Name.Table names = tsym.name.table; |
duke@1 | 940 | for (Scope.Entry e = tsym.members().lookup(names.fromString("<init>")); e.scope != null; e = e.next()) { |
duke@1 | 941 | if (e.sym.kind == Kinds.MTH) { |
duke@1 | 942 | if (hasParameterTypes((MethodSymbol)e.sym, paramTypes)) { |
duke@1 | 943 | return env.getConstructorDoc((MethodSymbol)e.sym); |
duke@1 | 944 | } |
duke@1 | 945 | } |
duke@1 | 946 | } |
duke@1 | 947 | |
duke@1 | 948 | //###(gj) As a temporary measure until type variables are better |
duke@1 | 949 | //### handled, try again without the parameter types. |
duke@1 | 950 | //### This will often find the right constructor, and occassionally |
duke@1 | 951 | //### find the wrong one. |
duke@1 | 952 | //if (paramTypes != null) { |
duke@1 | 953 | // return findConstructor(constrName, null); |
duke@1 | 954 | //} |
duke@1 | 955 | |
duke@1 | 956 | return null; |
duke@1 | 957 | } |
duke@1 | 958 | |
duke@1 | 959 | /** |
duke@1 | 960 | * Find a field in this class scope. |
duke@1 | 961 | * Search order: this class, outerclasses, interfaces, |
duke@1 | 962 | * superclasses. IMP: If see tag is defined in an inner class, |
duke@1 | 963 | * which extends a super class and if outerclass and the super |
duke@1 | 964 | * class have a visible field in common then Java compiler cribs |
duke@1 | 965 | * about the ambiguity, but the following code will search in the |
duke@1 | 966 | * above given search order. |
duke@1 | 967 | * |
duke@1 | 968 | * @param fieldName the unqualified name to search for. |
duke@1 | 969 | * @return the first FieldDocImpl which matches, null if not found. |
duke@1 | 970 | */ |
duke@1 | 971 | public FieldDoc findField(String fieldName) { |
duke@1 | 972 | return searchField(fieldName, new HashSet<ClassDocImpl>()); |
duke@1 | 973 | } |
duke@1 | 974 | |
duke@1 | 975 | private FieldDocImpl searchField(String fieldName, Set<ClassDocImpl> searched) { |
duke@1 | 976 | Name.Table names = tsym.name.table; |
duke@1 | 977 | if (searched.contains(this)) { |
duke@1 | 978 | return null; |
duke@1 | 979 | } |
duke@1 | 980 | searched.add(this); |
duke@1 | 981 | |
duke@1 | 982 | for (Scope.Entry e = tsym.members().lookup(names.fromString(fieldName)); e.scope != null; e = e.next()) { |
duke@1 | 983 | if (e.sym.kind == Kinds.VAR) { |
duke@1 | 984 | //### Should intern fieldName as Name. |
duke@1 | 985 | return env.getFieldDoc((VarSymbol)e.sym); |
duke@1 | 986 | } |
duke@1 | 987 | } |
duke@1 | 988 | |
duke@1 | 989 | //### If we found a FieldDoc above, but which did not pass |
duke@1 | 990 | //### the modifier filter, we should return failure here! |
duke@1 | 991 | |
duke@1 | 992 | ClassDocImpl cdi = (ClassDocImpl)containingClass(); |
duke@1 | 993 | if (cdi != null) { |
duke@1 | 994 | FieldDocImpl fdi = cdi.searchField(fieldName, searched); |
duke@1 | 995 | if (fdi != null) { |
duke@1 | 996 | return fdi; |
duke@1 | 997 | } |
duke@1 | 998 | } |
duke@1 | 999 | |
duke@1 | 1000 | // search superclass |
duke@1 | 1001 | cdi = (ClassDocImpl)superclass(); |
duke@1 | 1002 | if (cdi != null) { |
duke@1 | 1003 | FieldDocImpl fdi = cdi.searchField(fieldName, searched); |
duke@1 | 1004 | if (fdi != null) { |
duke@1 | 1005 | return fdi; |
duke@1 | 1006 | } |
duke@1 | 1007 | } |
duke@1 | 1008 | |
duke@1 | 1009 | // search interfaces |
duke@1 | 1010 | ClassDoc intf[] = interfaces(); |
duke@1 | 1011 | for (int i = 0; i < intf.length; i++) { |
duke@1 | 1012 | cdi = (ClassDocImpl)intf[i]; |
duke@1 | 1013 | FieldDocImpl fdi = cdi.searchField(fieldName, searched); |
duke@1 | 1014 | if (fdi != null) { |
duke@1 | 1015 | return fdi; |
duke@1 | 1016 | } |
duke@1 | 1017 | } |
duke@1 | 1018 | |
duke@1 | 1019 | return null; |
duke@1 | 1020 | } |
duke@1 | 1021 | |
duke@1 | 1022 | /** |
duke@1 | 1023 | * Get the list of classes declared as imported. |
duke@1 | 1024 | * These are called "single-type-import declarations" in the JLS. |
duke@1 | 1025 | * This method is deprecated in the ClassDoc interface. |
duke@1 | 1026 | * |
duke@1 | 1027 | * @return an array of ClassDocImpl representing the imported classes. |
duke@1 | 1028 | * |
duke@1 | 1029 | * @deprecated Import declarations are implementation details that |
duke@1 | 1030 | * should not be exposed here. In addition, not all imported |
duke@1 | 1031 | * classes are imported through single-type-import declarations. |
duke@1 | 1032 | */ |
duke@1 | 1033 | @Deprecated |
duke@1 | 1034 | public ClassDoc[] importedClasses() { |
duke@1 | 1035 | // information is not available for binary classfiles |
duke@1 | 1036 | if (tsym.sourcefile == null) return new ClassDoc[0]; |
duke@1 | 1037 | |
duke@1 | 1038 | ListBuffer<ClassDocImpl> importedClasses = new ListBuffer<ClassDocImpl>(); |
duke@1 | 1039 | |
duke@1 | 1040 | Env<AttrContext> compenv = env.enter.getEnv(tsym); |
duke@1 | 1041 | if (compenv == null) return new ClassDocImpl[0]; |
duke@1 | 1042 | |
duke@1 | 1043 | Name asterisk = tsym.name.table.asterisk; |
duke@1 | 1044 | for (JCTree t : compenv.toplevel.defs) { |
duke@1 | 1045 | if (t.getTag() == JCTree.IMPORT) { |
duke@1 | 1046 | JCTree imp = ((JCImport) t).qualid; |
duke@1 | 1047 | if ((TreeInfo.name(imp) != asterisk) && |
duke@1 | 1048 | (imp.type.tsym.kind & Kinds.TYP) != 0) { |
duke@1 | 1049 | importedClasses.append( |
duke@1 | 1050 | env.getClassDoc((ClassSymbol)imp.type.tsym)); |
duke@1 | 1051 | } |
duke@1 | 1052 | } |
duke@1 | 1053 | } |
duke@1 | 1054 | |
duke@1 | 1055 | return importedClasses.toArray(new ClassDocImpl[importedClasses.length()]); |
duke@1 | 1056 | } |
duke@1 | 1057 | |
duke@1 | 1058 | /** |
duke@1 | 1059 | * Get the list of packages declared as imported. |
duke@1 | 1060 | * These are called "type-import-on-demand declarations" in the JLS. |
duke@1 | 1061 | * This method is deprecated in the ClassDoc interface. |
duke@1 | 1062 | * |
duke@1 | 1063 | * @return an array of PackageDocImpl representing the imported packages. |
duke@1 | 1064 | * |
duke@1 | 1065 | * ###NOTE: the syntax supports importing all inner classes from a class as well. |
duke@1 | 1066 | * @deprecated Import declarations are implementation details that |
duke@1 | 1067 | * should not be exposed here. In addition, this method's |
duke@1 | 1068 | * return type does not allow for all type-import-on-demand |
duke@1 | 1069 | * declarations to be returned. |
duke@1 | 1070 | */ |
duke@1 | 1071 | @Deprecated |
duke@1 | 1072 | public PackageDoc[] importedPackages() { |
duke@1 | 1073 | // information is not available for binary classfiles |
duke@1 | 1074 | if (tsym.sourcefile == null) return new PackageDoc[0]; |
duke@1 | 1075 | |
duke@1 | 1076 | ListBuffer<PackageDocImpl> importedPackages = new ListBuffer<PackageDocImpl>(); |
duke@1 | 1077 | |
duke@1 | 1078 | //### Add the implicit "import java.lang.*" to the result |
duke@1 | 1079 | Name.Table names = tsym.name.table; |
duke@1 | 1080 | importedPackages.append(env.getPackageDoc(env.reader.enterPackage(names.java_lang))); |
duke@1 | 1081 | |
duke@1 | 1082 | Env<AttrContext> compenv = env.enter.getEnv(tsym); |
duke@1 | 1083 | if (compenv == null) return new PackageDocImpl[0]; |
duke@1 | 1084 | |
duke@1 | 1085 | for (JCTree t : compenv.toplevel.defs) { |
duke@1 | 1086 | if (t.getTag() == JCTree.IMPORT) { |
duke@1 | 1087 | JCTree imp = ((JCImport) t).qualid; |
duke@1 | 1088 | if (TreeInfo.name(imp) == names.asterisk) { |
duke@1 | 1089 | JCFieldAccess sel = (JCFieldAccess)imp; |
duke@1 | 1090 | Symbol s = sel.selected.type.tsym; |
duke@1 | 1091 | PackageDocImpl pdoc = env.getPackageDoc(s.packge()); |
duke@1 | 1092 | if (!importedPackages.contains(pdoc)) |
duke@1 | 1093 | importedPackages.append(pdoc); |
duke@1 | 1094 | } |
duke@1 | 1095 | } |
duke@1 | 1096 | } |
duke@1 | 1097 | |
duke@1 | 1098 | return importedPackages.toArray(new PackageDocImpl[importedPackages.length()]); |
duke@1 | 1099 | } |
duke@1 | 1100 | |
duke@1 | 1101 | /** |
duke@1 | 1102 | * Return the type's dimension information. |
duke@1 | 1103 | * Always return "", as this is not an array type. |
duke@1 | 1104 | */ |
duke@1 | 1105 | public String dimension() { |
duke@1 | 1106 | return ""; |
duke@1 | 1107 | } |
duke@1 | 1108 | |
duke@1 | 1109 | /** |
duke@1 | 1110 | * Return this type as a class, which it already is. |
duke@1 | 1111 | */ |
duke@1 | 1112 | public ClassDoc asClassDoc() { |
duke@1 | 1113 | return this; |
duke@1 | 1114 | } |
duke@1 | 1115 | |
duke@1 | 1116 | /** |
duke@1 | 1117 | * Return null (unless overridden), as this is not an annotation type. |
duke@1 | 1118 | */ |
duke@1 | 1119 | public AnnotationTypeDoc asAnnotationTypeDoc() { |
duke@1 | 1120 | return null; |
duke@1 | 1121 | } |
duke@1 | 1122 | |
duke@1 | 1123 | /** |
duke@1 | 1124 | * Return null, as this is not a class instantiation. |
duke@1 | 1125 | */ |
duke@1 | 1126 | public ParameterizedType asParameterizedType() { |
duke@1 | 1127 | return null; |
duke@1 | 1128 | } |
duke@1 | 1129 | |
duke@1 | 1130 | /** |
duke@1 | 1131 | * Return null, as this is not a type variable. |
duke@1 | 1132 | */ |
duke@1 | 1133 | public TypeVariable asTypeVariable() { |
duke@1 | 1134 | return null; |
duke@1 | 1135 | } |
duke@1 | 1136 | |
duke@1 | 1137 | /** |
duke@1 | 1138 | * Return null, as this is not a wildcard type. |
duke@1 | 1139 | */ |
duke@1 | 1140 | public WildcardType asWildcardType() { |
duke@1 | 1141 | return null; |
duke@1 | 1142 | } |
duke@1 | 1143 | |
duke@1 | 1144 | /** |
duke@1 | 1145 | * Return false, as this is not a primitive type. |
duke@1 | 1146 | */ |
duke@1 | 1147 | public boolean isPrimitive() { |
duke@1 | 1148 | return false; |
duke@1 | 1149 | } |
duke@1 | 1150 | |
duke@1 | 1151 | //--- Serialization --- |
duke@1 | 1152 | |
duke@1 | 1153 | //### These methods ignore modifier filter. |
duke@1 | 1154 | |
duke@1 | 1155 | /** |
duke@1 | 1156 | * Return true if this class implements <code>java.io.Serializable</code>. |
duke@1 | 1157 | * |
duke@1 | 1158 | * Since <code>java.io.Externalizable</code> extends |
duke@1 | 1159 | * <code>java.io.Serializable</code>, |
duke@1 | 1160 | * Externalizable objects are also Serializable. |
duke@1 | 1161 | */ |
duke@1 | 1162 | public boolean isSerializable() { |
duke@1 | 1163 | try { |
duke@1 | 1164 | return env.types.isSubtype(type, env.syms.serializableType); |
duke@1 | 1165 | } catch (CompletionFailure ex) { |
duke@1 | 1166 | // quietly ignore completion failures |
duke@1 | 1167 | return false; |
duke@1 | 1168 | } |
duke@1 | 1169 | } |
duke@1 | 1170 | |
duke@1 | 1171 | /** |
duke@1 | 1172 | * Return true if this class implements |
duke@1 | 1173 | * <code>java.io.Externalizable</code>. |
duke@1 | 1174 | */ |
duke@1 | 1175 | public boolean isExternalizable() { |
duke@1 | 1176 | try { |
duke@1 | 1177 | return env.types.isSubtype(type, env.externalizableSym.type); |
duke@1 | 1178 | } catch (CompletionFailure ex) { |
duke@1 | 1179 | // quietly ignore completion failures |
duke@1 | 1180 | return false; |
duke@1 | 1181 | } |
duke@1 | 1182 | } |
duke@1 | 1183 | |
duke@1 | 1184 | /** |
duke@1 | 1185 | * Return the serialization methods for this class. |
duke@1 | 1186 | * |
duke@1 | 1187 | * @return an array of <code>MethodDocImpl</code> that represents |
duke@1 | 1188 | * the serialization methods for this class. |
duke@1 | 1189 | */ |
duke@1 | 1190 | public MethodDoc[] serializationMethods() { |
duke@1 | 1191 | if (serializedForm == null) { |
duke@1 | 1192 | serializedForm = new SerializedForm(env, tsym, this); |
duke@1 | 1193 | } |
duke@1 | 1194 | //### Clone this? |
duke@1 | 1195 | return serializedForm.methods(); |
duke@1 | 1196 | } |
duke@1 | 1197 | |
duke@1 | 1198 | /** |
duke@1 | 1199 | * Return the Serializable fields of class.<p> |
duke@1 | 1200 | * |
duke@1 | 1201 | * Return either a list of default fields documented by |
duke@1 | 1202 | * <code>serial</code> tag<br> |
duke@1 | 1203 | * or return a single <code>FieldDoc</code> for |
duke@1 | 1204 | * <code>serialPersistentField</code> member. |
duke@1 | 1205 | * There should be a <code>serialField</code> tag for |
duke@1 | 1206 | * each Serializable field defined by an <code>ObjectStreamField</code> |
duke@1 | 1207 | * array component of <code>serialPersistentField</code>. |
duke@1 | 1208 | * |
duke@1 | 1209 | * @returns an array of <code>FieldDoc</code> for the Serializable fields |
duke@1 | 1210 | * of this class. |
duke@1 | 1211 | * |
duke@1 | 1212 | * @see #definesSerializableFields() |
duke@1 | 1213 | * @see SerialFieldTagImpl |
duke@1 | 1214 | */ |
duke@1 | 1215 | public FieldDoc[] serializableFields() { |
duke@1 | 1216 | if (serializedForm == null) { |
duke@1 | 1217 | serializedForm = new SerializedForm(env, tsym, this); |
duke@1 | 1218 | } |
duke@1 | 1219 | //### Clone this? |
duke@1 | 1220 | return serializedForm.fields(); |
duke@1 | 1221 | } |
duke@1 | 1222 | |
duke@1 | 1223 | /** |
duke@1 | 1224 | * Return true if Serializable fields are explicitly defined with |
duke@1 | 1225 | * the special class member <code>serialPersistentFields</code>. |
duke@1 | 1226 | * |
duke@1 | 1227 | * @see #serializableFields() |
duke@1 | 1228 | * @see SerialFieldTagImpl |
duke@1 | 1229 | */ |
duke@1 | 1230 | public boolean definesSerializableFields() { |
duke@1 | 1231 | if (!isSerializable() || isExternalizable()) { |
duke@1 | 1232 | return false; |
duke@1 | 1233 | } else { |
duke@1 | 1234 | if (serializedForm == null) { |
duke@1 | 1235 | serializedForm = new SerializedForm(env, tsym, this); |
duke@1 | 1236 | } |
duke@1 | 1237 | //### Clone this? |
duke@1 | 1238 | return serializedForm.definesSerializableFields(); |
duke@1 | 1239 | } |
duke@1 | 1240 | } |
duke@1 | 1241 | |
duke@1 | 1242 | /** |
duke@1 | 1243 | * Determine if a class is a RuntimeException. |
duke@1 | 1244 | * <p> |
duke@1 | 1245 | * Used only by ThrowsTagImpl. |
duke@1 | 1246 | */ |
duke@1 | 1247 | boolean isRuntimeException() { |
duke@1 | 1248 | return tsym.isSubClass(env.syms.runtimeExceptionType.tsym, env.types); |
duke@1 | 1249 | } |
duke@1 | 1250 | |
duke@1 | 1251 | /** |
duke@1 | 1252 | * Return the source position of the entity, or null if |
duke@1 | 1253 | * no position is available. |
duke@1 | 1254 | */ |
duke@1 | 1255 | public SourcePosition position() { |
duke@1 | 1256 | if (tsym.sourcefile == null) return null; |
duke@1 | 1257 | return SourcePositionImpl.make(tsym.sourcefile.toString(), |
duke@1 | 1258 | (tree==null) ? Position.NOPOS : tree.pos, |
duke@1 | 1259 | lineMap); |
duke@1 | 1260 | } |
duke@1 | 1261 | } |