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

Wed, 10 Oct 2012 16:48:21 -0700

author
jjg
date
Wed, 10 Oct 2012 16:48:21 -0700
changeset 1359
25e14ad23cef
parent 1357
c75be5bc5283
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy

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

mercurial