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