Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/TypeVariableImpl.java@9a66ca7c79fa (annotated)
src/share/classes/com/sun/tools/javadoc/TypeVariableImpl.java
Sat, 01 Dec 2007 00:00:00 +0000
- author
- duke
- date
- Sat, 01 Dec 2007 00:00:00 +0000
- changeset 1
- 9a66ca7c79fa
- child 113
- eff38cc97183
- permissions
- -rw-r--r--
Initial load
| 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 com.sun.tools.javac.code.Kinds; |
| duke@1 | 32 | import com.sun.tools.javac.code.Symbol; |
| duke@1 | 33 | import com.sun.tools.javac.code.Symbol.ClassSymbol; |
| duke@1 | 34 | import com.sun.tools.javac.code.Symbol.MethodSymbol; |
| duke@1 | 35 | import com.sun.tools.javac.code.Type; |
| duke@1 | 36 | import com.sun.tools.javac.code.Type.TypeVar; |
| duke@1 | 37 | import com.sun.tools.javac.util.List; |
| duke@1 | 38 | import com.sun.tools.javac.util.Name; |
| duke@1 | 39 | |
| duke@1 | 40 | /** |
| duke@1 | 41 | * Implementation of <code>TypeVariable</code>, which |
| duke@1 | 42 | * represents a type variable. |
| duke@1 | 43 | * |
| duke@1 | 44 | * @author Scott Seligman |
| duke@1 | 45 | * @since 1.5 |
| duke@1 | 46 | */ |
| duke@1 | 47 | public class TypeVariableImpl extends AbstractTypeImpl implements TypeVariable { |
| duke@1 | 48 | |
| duke@1 | 49 | TypeVariableImpl(DocEnv env, TypeVar type) { |
| duke@1 | 50 | super(env, type); |
| duke@1 | 51 | } |
| duke@1 | 52 | |
| duke@1 | 53 | /** |
| duke@1 | 54 | * Return the bounds of this type variable. |
| duke@1 | 55 | */ |
| duke@1 | 56 | public com.sun.javadoc.Type[] bounds() { |
| duke@1 | 57 | return TypeMaker.getTypes(env, getBounds((TypeVar)type, env)); |
| duke@1 | 58 | } |
| duke@1 | 59 | |
| duke@1 | 60 | /** |
| duke@1 | 61 | * Return the class, interface, method, or constructor within |
| duke@1 | 62 | * which this type variable is declared. |
| duke@1 | 63 | */ |
| duke@1 | 64 | public ProgramElementDoc owner() { |
| duke@1 | 65 | Symbol osym = type.tsym.owner; |
| duke@1 | 66 | if ((osym.kind & Kinds.TYP) != 0) { |
| duke@1 | 67 | return env.getClassDoc((ClassSymbol)osym); |
| duke@1 | 68 | } |
| duke@1 | 69 | Name.Table names = osym.name.table; |
| duke@1 | 70 | if (osym.name == names.init) { |
| duke@1 | 71 | return env.getConstructorDoc((MethodSymbol)osym); |
| duke@1 | 72 | } else { |
| duke@1 | 73 | return env.getMethodDoc((MethodSymbol)osym); |
| duke@1 | 74 | } |
| duke@1 | 75 | } |
| duke@1 | 76 | |
| duke@1 | 77 | /** |
| duke@1 | 78 | * Return the ClassDoc of the erasure of this type variable. |
| duke@1 | 79 | */ |
| duke@1 | 80 | public ClassDoc asClassDoc() { |
| duke@1 | 81 | return env.getClassDoc((ClassSymbol)env.types.erasure(type).tsym); |
| duke@1 | 82 | } |
| duke@1 | 83 | |
| duke@1 | 84 | public TypeVariable asTypeVariable() { |
| duke@1 | 85 | return this; |
| duke@1 | 86 | } |
| duke@1 | 87 | |
| duke@1 | 88 | public String toString() { |
| duke@1 | 89 | return typeVarToString(env, (TypeVar)type, true); |
| duke@1 | 90 | } |
| duke@1 | 91 | |
| duke@1 | 92 | |
| duke@1 | 93 | /** |
| duke@1 | 94 | * Return the string form of a type variable along with any |
| duke@1 | 95 | * "extends" clause. Class names are qualified if "full" is true. |
| duke@1 | 96 | */ |
| duke@1 | 97 | static String typeVarToString(DocEnv env, TypeVar v, boolean full) { |
| duke@1 | 98 | StringBuffer s = new StringBuffer(v.toString()); |
| duke@1 | 99 | List<Type> bounds = getBounds(v, env); |
| duke@1 | 100 | if (bounds.nonEmpty()) { |
| duke@1 | 101 | boolean first = true; |
| duke@1 | 102 | for (Type b : bounds) { |
| duke@1 | 103 | s.append(first ? " extends " : " & "); |
| duke@1 | 104 | s.append(TypeMaker.getTypeString(env, b, full)); |
| duke@1 | 105 | first = false; |
| duke@1 | 106 | } |
| duke@1 | 107 | } |
| duke@1 | 108 | return s.toString(); |
| duke@1 | 109 | } |
| duke@1 | 110 | |
| duke@1 | 111 | /** |
| duke@1 | 112 | * Get the bounds of a type variable as listed in the "extends" clause. |
| duke@1 | 113 | */ |
| duke@1 | 114 | private static List<Type> getBounds(TypeVar v, DocEnv env) { |
| duke@1 | 115 | Name boundname = v.getUpperBound().tsym.getQualifiedName(); |
| duke@1 | 116 | if (boundname == boundname.table.java_lang_Object) { |
| duke@1 | 117 | return List.nil(); |
| duke@1 | 118 | } else { |
| duke@1 | 119 | return env.types.getBounds(v); |
| duke@1 | 120 | } |
| duke@1 | 121 | } |
| duke@1 | 122 | } |
