| /* |
| * Copyright 2003-2008 Sun Microsystems, Inc. All Rights Reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Sun designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Sun in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| * CA 95054 USA or visit www.sun.com if you need additional information or |
| * have any questions. |
| */ |
| |
| package com.sun.tools.javadoc; |
| |
| |
| import com.sun.javadoc.*; |
| |
| import com.sun.tools.javac.code.Kinds; |
| import com.sun.tools.javac.code.Symbol; |
| import com.sun.tools.javac.code.Symbol.ClassSymbol; |
| import com.sun.tools.javac.code.Symbol.MethodSymbol; |
| import com.sun.tools.javac.code.Type; |
| import com.sun.tools.javac.code.Type.TypeVar; |
| import com.sun.tools.javac.util.List; |
| import com.sun.tools.javac.util.Name; |
| import com.sun.tools.javac.util.Names; |
| |
| /** |
| * Implementation of <code>TypeVariable</code>, which |
| * represents a type variable. |
| * |
| * @author Scott Seligman |
| * @since 1.5 |
| */ |
| public class TypeVariableImpl extends AbstractTypeImpl implements TypeVariable { |
| |
| TypeVariableImpl(DocEnv env, TypeVar type) { |
| super(env, type); |
| } |
| |
| /** |
| * Return the bounds of this type variable. |
| */ |
| public com.sun.javadoc.Type[] bounds() { |
| return TypeMaker.getTypes(env, getBounds((TypeVar)type, env)); |
| } |
| |
| /** |
| * Return the class, interface, method, or constructor within |
| * which this type variable is declared. |
| */ |
| public ProgramElementDoc owner() { |
| Symbol osym = type.tsym.owner; |
| if ((osym.kind & Kinds.TYP) != 0) { |
| return env.getClassDoc((ClassSymbol)osym); |
| } |
| Names names = osym.name.table.names; |
| if (osym.name == names.init) { |
| return env.getConstructorDoc((MethodSymbol)osym); |
| } else { |
| return env.getMethodDoc((MethodSymbol)osym); |
| } |
| } |
| |
| /** |
| * Return the ClassDoc of the erasure of this type variable. |
| */ |
| public ClassDoc asClassDoc() { |
| return env.getClassDoc((ClassSymbol)env.types.erasure(type).tsym); |
| } |
| |
| public TypeVariable asTypeVariable() { |
| return this; |
| } |
| |
| public String toString() { |
| return typeVarToString(env, (TypeVar)type, true); |
| } |
| |
| |
| /** |
| * Return the string form of a type variable along with any |
| * "extends" clause. Class names are qualified if "full" is true. |
| */ |
| static String typeVarToString(DocEnv env, TypeVar v, boolean full) { |
| StringBuffer s = new StringBuffer(v.toString()); |
| List<Type> bounds = getBounds(v, env); |
| if (bounds.nonEmpty()) { |
| boolean first = true; |
| for (Type b : bounds) { |
| s.append(first ? " extends " : " & "); |
| s.append(TypeMaker.getTypeString(env, b, full)); |
| first = false; |
| } |
| } |
| return s.toString(); |
| } |
| |
| /** |
| * Get the bounds of a type variable as listed in the "extends" clause. |
| */ |
| private static List<Type> getBounds(TypeVar v, DocEnv env) { |
| Name boundname = v.getUpperBound().tsym.getQualifiedName(); |
| if (boundname == boundname.table.names.java_lang_Object) { |
| return List.nil(); |
| } else { |
| return env.types.getBounds(v); |
| } |
| } |
| } |