duke@1: /*
jjg@1521: * Copyright (c) 2003, 2013, Oracle and/or its affiliates. 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
ohair@554: * published by the Free Software Foundation. Oracle designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
ohair@554: * by Oracle 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: *
ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554: * or visit www.oracle.com if you need additional information or have any
ohair@554: * questions.
duke@1: */
duke@1:
duke@1: package com.sun.tools.javadoc;
duke@1:
duke@1: import com.sun.javadoc.*;
duke@1:
jjg@1521: import com.sun.tools.javac.code.Attribute;
jjg@1521: import com.sun.tools.javac.code.Attribute.TypeCompound;
duke@1: import com.sun.tools.javac.code.Kinds;
duke@1: import com.sun.tools.javac.code.Symbol;
duke@1: import com.sun.tools.javac.code.Symbol.ClassSymbol;
duke@1: import com.sun.tools.javac.code.Symbol.MethodSymbol;
duke@1: import com.sun.tools.javac.code.Type;
duke@1: import com.sun.tools.javac.code.Type.TypeVar;
duke@1: import com.sun.tools.javac.util.List;
duke@1: import com.sun.tools.javac.util.Name;
jjg@113: import com.sun.tools.javac.util.Names;
duke@1:
duke@1: /**
duke@1: * Implementation of TypeVariable, which
duke@1: * represents a type variable.
duke@1: *
jjg@1359: * This is NOT part of any supported API.
jjg@1359: * If you write code that depends on this, you do so at your own risk.
jjg@1359: * This code and its internal interfaces are subject to change or
jjg@1359: * deletion without notice.
jjg@1359: *
duke@1: * @author Scott Seligman
duke@1: * @since 1.5
duke@1: */
duke@1: public class TypeVariableImpl extends AbstractTypeImpl implements TypeVariable {
duke@1:
duke@1: TypeVariableImpl(DocEnv env, TypeVar type) {
duke@1: super(env, type);
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the bounds of this type variable.
duke@1: */
duke@1: public com.sun.javadoc.Type[] bounds() {
duke@1: return TypeMaker.getTypes(env, getBounds((TypeVar)type, env));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the class, interface, method, or constructor within
duke@1: * which this type variable is declared.
duke@1: */
duke@1: public ProgramElementDoc owner() {
duke@1: Symbol osym = type.tsym.owner;
duke@1: if ((osym.kind & Kinds.TYP) != 0) {
duke@1: return env.getClassDoc((ClassSymbol)osym);
duke@1: }
jjg@113: Names names = osym.name.table.names;
duke@1: if (osym.name == names.init) {
duke@1: return env.getConstructorDoc((MethodSymbol)osym);
duke@1: } else {
duke@1: return env.getMethodDoc((MethodSymbol)osym);
duke@1: }
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the ClassDoc of the erasure of this type variable.
duke@1: */
jjg@910: @Override
duke@1: public ClassDoc asClassDoc() {
duke@1: return env.getClassDoc((ClassSymbol)env.types.erasure(type).tsym);
duke@1: }
duke@1:
jjg@910: @Override
duke@1: public TypeVariable asTypeVariable() {
duke@1: return this;
duke@1: }
duke@1:
jjg@910: @Override
duke@1: public String toString() {
duke@1: return typeVarToString(env, (TypeVar)type, true);
duke@1: }
duke@1:
duke@1:
duke@1: /**
duke@1: * Return the string form of a type variable along with any
duke@1: * "extends" clause. Class names are qualified if "full" is true.
duke@1: */
duke@1: static String typeVarToString(DocEnv env, TypeVar v, boolean full) {
jjg@910: StringBuilder s = new StringBuilder(v.toString());
duke@1: List bounds = getBounds(v, env);
duke@1: if (bounds.nonEmpty()) {
duke@1: boolean first = true;
duke@1: for (Type b : bounds) {
duke@1: s.append(first ? " extends " : " & ");
duke@1: s.append(TypeMaker.getTypeString(env, b, full));
duke@1: first = false;
duke@1: }
duke@1: }
duke@1: return s.toString();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Get the bounds of a type variable as listed in the "extends" clause.
duke@1: */
duke@1: private static List getBounds(TypeVar v, DocEnv env) {
jjg@1521: final Type upperBound = v.getUpperBound();
jjg@1521: Name boundname = upperBound.tsym.getQualifiedName();
jjg@1521: if (boundname == boundname.table.names.java_lang_Object
jjg@1644: && !upperBound.isAnnotated()) {
duke@1: return List.nil();
duke@1: } else {
duke@1: return env.types.getBounds(v);
duke@1: }
duke@1: }
jjg@1521:
jjg@1521: /**
jjg@1521: * Get the annotations of this program element.
jjg@1521: * Return an empty array if there are none.
jjg@1521: */
jjg@1521: public AnnotationDesc[] annotations() {
jjg@1644: if (!type.isAnnotated()) {
jjg@1521: return new AnnotationDesc[0];
jjg@1521: }
jjg@1992: List tas = type.getAnnotationMirrors();
jjg@1521: AnnotationDesc res[] = new AnnotationDesc[tas.length()];
jjg@1521: int i = 0;
jjg@1521: for (Attribute.Compound a : tas) {
jjg@1521: res[i++] = new AnnotationDescImpl(env, a);
jjg@1521: }
jjg@1521: return res;
jjg@1521: }
duke@1: }