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

Thu, 18 Sep 2008 18:39:44 -0700

author
jjg
date
Thu, 18 Sep 2008 18:39:44 -0700
changeset 115
829dea15ff99
parent 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

6744408: Extra ouput is appearing in stderr
Reviewed-by: bpatel

duke@1 1 /*
duke@1 2 * Copyright 2003-2005 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
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.util.List;
duke@1 36
duke@1 37
duke@1 38 /**
duke@1 39 * Implementation of <code>WildcardType</code>, which
duke@1 40 * represents a wildcard type.
duke@1 41 *
duke@1 42 * @author Scott Seligman
duke@1 43 * @since 1.5
duke@1 44 */
duke@1 45 public class WildcardTypeImpl extends AbstractTypeImpl implements WildcardType {
duke@1 46
duke@1 47 WildcardTypeImpl(DocEnv env, Type.WildcardType type) {
duke@1 48 super(env, type);
duke@1 49 }
duke@1 50
duke@1 51 /**
duke@1 52 * Return the upper bounds of this wildcard type argument
duke@1 53 * as given by the <i>extends</i> clause.
duke@1 54 * Return an empty array if no such bounds are explicitly given.
duke@1 55 */
duke@1 56 public com.sun.javadoc.Type[] extendsBounds() {
duke@1 57 return TypeMaker.getTypes(env, getExtendsBounds((Type.WildcardType)type));
duke@1 58 }
duke@1 59
duke@1 60 /**
duke@1 61 * Return the lower bounds of this wildcard type argument
duke@1 62 * as given by the <i>super</i> clause.
duke@1 63 * Return an empty array if no such bounds are explicitly given.
duke@1 64 */
duke@1 65 public com.sun.javadoc.Type[] superBounds() {
duke@1 66 return TypeMaker.getTypes(env, getSuperBounds((Type.WildcardType)type));
duke@1 67 }
duke@1 68
duke@1 69 /**
duke@1 70 * Return the ClassDoc of the erasure of this wildcard type.
duke@1 71 */
duke@1 72 public ClassDoc asClassDoc() {
duke@1 73 return env.getClassDoc((ClassSymbol)env.types.erasure(type).tsym);
duke@1 74 }
duke@1 75
duke@1 76 public WildcardType asWildcardType() {
duke@1 77 return this;
duke@1 78 }
duke@1 79
duke@1 80 public String typeName() { return "?"; }
duke@1 81 public String qualifiedTypeName() { return "?"; }
duke@1 82 public String simpleTypeName() { return "?"; }
duke@1 83
duke@1 84 public String toString() {
duke@1 85 return wildcardTypeToString(env, (Type.WildcardType)type, true);
duke@1 86 }
duke@1 87
duke@1 88
duke@1 89 /**
duke@1 90 * Return the string form of a wildcard type ("?") along with any
duke@1 91 * "extends" or "super" clause. Delimiting brackets are not
duke@1 92 * included. Class names are qualified if "full" is true.
duke@1 93 */
duke@1 94 static String wildcardTypeToString(DocEnv env,
duke@1 95 Type.WildcardType wildThing, boolean full) {
duke@1 96 if (env.legacyDoclet) {
duke@1 97 return TypeMaker.getTypeName(env.types.erasure(wildThing), full);
duke@1 98 }
duke@1 99 StringBuffer s = new StringBuffer("?");
duke@1 100 List<Type> bounds = getExtendsBounds(wildThing);
duke@1 101 if (bounds.nonEmpty()) {
duke@1 102 s.append(" extends ");
duke@1 103 } else {
duke@1 104 bounds = getSuperBounds(wildThing);
duke@1 105 if (bounds.nonEmpty()) {
duke@1 106 s.append(" super ");
duke@1 107 }
duke@1 108 }
duke@1 109 boolean first = true; // currently only one bound is allowed
duke@1 110 for (Type b : bounds) {
duke@1 111 if (!first) {
duke@1 112 s.append(" & ");
duke@1 113 }
duke@1 114 s.append(TypeMaker.getTypeString(env, b, full));
duke@1 115 first = false;
duke@1 116 }
duke@1 117 return s.toString();
duke@1 118 }
duke@1 119
duke@1 120 private static List<Type> getExtendsBounds(Type.WildcardType wild) {
duke@1 121 return wild.isSuperBound()
duke@1 122 ? List.<Type>nil()
duke@1 123 : List.of(wild.type);
duke@1 124 }
duke@1 125
duke@1 126 private static List<Type> getSuperBounds(Type.WildcardType wild) {
duke@1 127 return wild.isExtendsBound()
duke@1 128 ? List.<Type>nil()
duke@1 129 : List.of(wild.type);
duke@1 130 }
duke@1 131 }

mercurial