duke@1: /*
duke@1: * Copyright 2003-2005 Sun Microsystems, Inc. All Rights Reserved.
duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1: *
duke@1: * This code is free software; you can redistribute it and/or modify it
duke@1: * under the terms of the GNU General Public License version 2 only, as
duke@1: * published by the Free Software Foundation. Sun designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
duke@1: * by Sun in the LICENSE file that accompanied this code.
duke@1: *
duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1: * version 2 for more details (a copy is included in the LICENSE file that
duke@1: * accompanied this code).
duke@1: *
duke@1: * You should have received a copy of the GNU General Public License version
duke@1: * 2 along with this work; if not, write to the Free Software Foundation,
duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1: *
duke@1: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1: * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1: * have any questions.
duke@1: */
duke@1:
duke@1: package com.sun.tools.javadoc;
duke@1:
duke@1:
duke@1: import com.sun.javadoc.*;
duke@1:
duke@1: import static com.sun.javadoc.LanguageVersion.*;
duke@1:
duke@1: import com.sun.tools.javac.code.Symbol.ClassSymbol;
duke@1: import com.sun.tools.javac.code.Type;
duke@1: import com.sun.tools.javac.util.List;
duke@1:
duke@1:
duke@1: /**
duke@1: * Implementation of WildcardType
, which
duke@1: * represents a wildcard type.
duke@1: *
duke@1: * @author Scott Seligman
duke@1: * @since 1.5
duke@1: */
duke@1: public class WildcardTypeImpl extends AbstractTypeImpl implements WildcardType {
duke@1:
duke@1: WildcardTypeImpl(DocEnv env, Type.WildcardType type) {
duke@1: super(env, type);
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the upper bounds of this wildcard type argument
duke@1: * as given by the extends clause.
duke@1: * Return an empty array if no such bounds are explicitly given.
duke@1: */
duke@1: public com.sun.javadoc.Type[] extendsBounds() {
duke@1: return TypeMaker.getTypes(env, getExtendsBounds((Type.WildcardType)type));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the lower bounds of this wildcard type argument
duke@1: * as given by the super clause.
duke@1: * Return an empty array if no such bounds are explicitly given.
duke@1: */
duke@1: public com.sun.javadoc.Type[] superBounds() {
duke@1: return TypeMaker.getTypes(env, getSuperBounds((Type.WildcardType)type));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the ClassDoc of the erasure of this wildcard type.
duke@1: */
duke@1: public ClassDoc asClassDoc() {
duke@1: return env.getClassDoc((ClassSymbol)env.types.erasure(type).tsym);
duke@1: }
duke@1:
duke@1: public WildcardType asWildcardType() {
duke@1: return this;
duke@1: }
duke@1:
duke@1: public String typeName() { return "?"; }
duke@1: public String qualifiedTypeName() { return "?"; }
duke@1: public String simpleTypeName() { return "?"; }
duke@1:
duke@1: public String toString() {
duke@1: return wildcardTypeToString(env, (Type.WildcardType)type, true);
duke@1: }
duke@1:
duke@1:
duke@1: /**
duke@1: * Return the string form of a wildcard type ("?") along with any
duke@1: * "extends" or "super" clause. Delimiting brackets are not
duke@1: * included. Class names are qualified if "full" is true.
duke@1: */
duke@1: static String wildcardTypeToString(DocEnv env,
duke@1: Type.WildcardType wildThing, boolean full) {
duke@1: if (env.legacyDoclet) {
duke@1: return TypeMaker.getTypeName(env.types.erasure(wildThing), full);
duke@1: }
duke@1: StringBuffer s = new StringBuffer("?");
duke@1: List bounds = getExtendsBounds(wildThing);
duke@1: if (bounds.nonEmpty()) {
duke@1: s.append(" extends ");
duke@1: } else {
duke@1: bounds = getSuperBounds(wildThing);
duke@1: if (bounds.nonEmpty()) {
duke@1: s.append(" super ");
duke@1: }
duke@1: }
duke@1: boolean first = true; // currently only one bound is allowed
duke@1: for (Type b : bounds) {
duke@1: if (!first) {
duke@1: s.append(" & ");
duke@1: }
duke@1: s.append(TypeMaker.getTypeString(env, b, full));
duke@1: first = false;
duke@1: }
duke@1: return s.toString();
duke@1: }
duke@1:
duke@1: private static List getExtendsBounds(Type.WildcardType wild) {
duke@1: return wild.isSuperBound()
duke@1: ? List.nil()
duke@1: : List.of(wild.type);
duke@1: }
duke@1:
duke@1: private static List getSuperBounds(Type.WildcardType wild) {
duke@1: return wild.isExtendsBound()
duke@1: ? List.nil()
duke@1: : List.of(wild.type);
duke@1: }
duke@1: }