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

Fri, 11 Jun 2010 17:24:23 -0700

author
jjg
date
Fri, 11 Jun 2010 17:24:23 -0700
changeset 584
d1ea43cb71c1
parent 554
9d9f26857129
child 910
ebf7c13df6c0
permissions
-rw-r--r--

6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
Reviewed-by: darcy

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