Mercurial > jdk8-mips64-public > langtools / file revision

 /*

  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. 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.  Oracle designates this

  * particular file as subject to the "Classpath" exception as provided

  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

  * or visit www.oracle.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.Attribute;

 import com.sun.tools.javac.code.Attribute.TypeCompound;

 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.

  *

  *  <p><b>This is NOT part of any supported API.

  *  If you write code that depends on this, you do so at your own risk.

  *  This code and its internal interfaces are subject to change or

  *  deletion without notice.</b>

  *

  * @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.

      */

     @Override

     public ClassDoc asClassDoc() {

         return env.getClassDoc((ClassSymbol)env.types.erasure(type).tsym);

     }

     @Override

     public TypeVariable asTypeVariable() {

         return this;

     }

     @Override

     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) {

         StringBuilder s = new StringBuilder(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) {

         final Type upperBound = v.getUpperBound();

         Name boundname = upperBound.tsym.getQualifiedName();

         if (boundname == boundname.table.names.java_lang_Object

             && !upperBound.isAnnotated()) {

             return List.nil();

         } else {

             return env.types.getBounds(v);

         }

     }

     /**

      * Get the annotations of this program element.

      * Return an empty array if there are none.

      */

     public AnnotationDesc[] annotations() {

         if (!type.isAnnotated()) {

             return new AnnotationDesc[0];

         }

         List<? extends TypeCompound> tas = type.getAnnotationMirrors();

         AnnotationDesc res[] = new AnnotationDesc[tas.length()];

         int i = 0;

         for (Attribute.Compound a : tas) {

             res[i++] = new AnnotationDescImpl(env, a);

         }

         return res;

     }

 }