src/share/classes/com/sun/tools/javadoc/ParameterizedTypeImpl.java

Mon, 25 Apr 2011 20:16:46 -0700

author
mfang
date
Mon, 25 Apr 2011 20:16:46 -0700
changeset 975
841e1c6a5914
parent 910
ebf7c13df6c0
child 1359
25e14ad23cef
permissions
-rw-r--r--

7039493: incorporating WPTG translation bug fixes
Reviewed-by: yhuang

duke@1 1 /*
jjg@910 2 * Copyright (c) 2003, 2011, 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.javadoc;
duke@1 27
duke@1 28 import com.sun.javadoc.*;
duke@1 29
duke@1 30 import com.sun.tools.javac.code.Symbol.ClassSymbol;
duke@1 31 import com.sun.tools.javac.code.Type;
duke@1 32 import com.sun.tools.javac.code.Type.ClassType;
duke@1 33
duke@1 34 import static com.sun.tools.javac.code.TypeTags.*;
duke@1 35
duke@1 36
duke@1 37 /**
duke@1 38 * Implementation of <code>ParameterizedType</code>, which
duke@1 39 * represents an invocation of a generic class or interface.
duke@1 40 *
duke@1 41 * @author Scott Seligman
duke@1 42 * @since 1.5
duke@1 43 */
duke@1 44 public class ParameterizedTypeImpl
duke@1 45 extends AbstractTypeImpl implements ParameterizedType {
duke@1 46
duke@1 47 ParameterizedTypeImpl(DocEnv env, Type type) {
duke@1 48 super(env, type);
duke@1 49 }
duke@1 50
duke@1 51 /**
duke@1 52 * Return the generic class or interface that declared this type.
duke@1 53 */
jjg@910 54 @Override
duke@1 55 public ClassDoc asClassDoc() {
duke@1 56 return env.getClassDoc((ClassSymbol)type.tsym);
duke@1 57 }
duke@1 58
duke@1 59 /**
duke@1 60 * Return the actual type arguments of this type.
duke@1 61 */
duke@1 62 public com.sun.javadoc.Type[] typeArguments() {
duke@1 63 return TypeMaker.getTypes(env, type.getTypeArguments());
duke@1 64 }
duke@1 65
duke@1 66 /**
duke@1 67 * Return the class type that is a direct supertype of this one.
duke@1 68 * Return null if this is an interface type.
duke@1 69 */
duke@1 70 public com.sun.javadoc.Type superclassType() {
duke@1 71 if (asClassDoc().isInterface()) {
duke@1 72 return null;
duke@1 73 }
duke@1 74 Type sup = env.types.supertype(type);
duke@1 75 return TypeMaker.getType(env,
duke@1 76 (sup != type) ? sup : env.syms.objectType);
duke@1 77 }
duke@1 78
duke@1 79 /**
duke@1 80 * Return the interface types directly implemented by or extended by this
duke@1 81 * parameterized type.
duke@1 82 * Return an empty array if there are no interfaces.
duke@1 83 */
duke@1 84 public com.sun.javadoc.Type[] interfaceTypes() {
duke@1 85 return TypeMaker.getTypes(env, env.types.interfaces(type));
duke@1 86 }
duke@1 87
duke@1 88 /**
duke@1 89 * Return the type that contains this type as a member.
duke@1 90 * Return null is this is a top-level type.
duke@1 91 */
duke@1 92 public com.sun.javadoc.Type containingType() {
duke@1 93 if (type.getEnclosingType().tag == CLASS) {
duke@1 94 // This is the type of an inner class.
duke@1 95 return TypeMaker.getType(env, type.getEnclosingType());
duke@1 96 }
duke@1 97 ClassSymbol enclosing = type.tsym.owner.enclClass();
duke@1 98 if (enclosing != null) {
duke@1 99 // Nested but not inner. Return the ClassDoc of the enclosing
duke@1 100 // class or interface.
duke@1 101 // See java.lang.reflect.ParameterizedType.getOwnerType().
duke@1 102 return env.getClassDoc(enclosing);
duke@1 103 }
duke@1 104 return null;
duke@1 105 }
duke@1 106
duke@1 107
duke@1 108 // Asking for the "name" of a parameterized type doesn't exactly make
duke@1 109 // sense. It's a type expression. Return the name of its generic
duke@1 110 // type.
jjg@910 111 @Override
duke@1 112 public String typeName() {
duke@1 113 return TypeMaker.getTypeName(type, false);
duke@1 114 }
duke@1 115
jjg@910 116 @Override
duke@1 117 public ParameterizedType asParameterizedType() {
duke@1 118 return this;
duke@1 119 }
duke@1 120
jjg@910 121 @Override
duke@1 122 public String toString() {
duke@1 123 return parameterizedTypeToString(env, (ClassType)type, true);
duke@1 124 }
duke@1 125
duke@1 126 static String parameterizedTypeToString(DocEnv env, ClassType cl,
duke@1 127 boolean full) {
duke@1 128 if (env.legacyDoclet) {
duke@1 129 return TypeMaker.getTypeName(cl, full);
duke@1 130 }
jjg@910 131 StringBuilder s = new StringBuilder();
duke@1 132 if (cl.getEnclosingType().tag != CLASS) { // if not an inner class...
duke@1 133 s.append(TypeMaker.getTypeName(cl, full));
duke@1 134 } else {
duke@1 135 ClassType encl = (ClassType)cl.getEnclosingType();
duke@1 136 s.append(parameterizedTypeToString(env, encl, full))
duke@1 137 .append('.')
duke@1 138 .append(cl.tsym.name.toString());
duke@1 139 }
duke@1 140 s.append(TypeMaker.typeArgumentsString(env, cl, full));
duke@1 141 return s.toString();
duke@1 142 }
duke@1 143 }

mercurial