src/share/classes/com/sun/tools/javadoc/WildcardTypeImpl.java

Mon, 25 Mar 2013 16:55:14 -0700

author
mfang
date
Mon, 25 Mar 2013 16:55:14 -0700
changeset 1658
fdf30b225e1c
parent 1359
25e14ad23cef
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8010521: jdk8 l10n resource file translation update 2
Reviewed-by: naoto, yhuang

     1 /*
     2  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.  Oracle designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Oracle in the LICENSE file that accompanied this code.
    10  *
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    14  * version 2 for more details (a copy is included in the LICENSE file that
    15  * accompanied this code).
    16  *
    17  * You should have received a copy of the GNU General Public License version
    18  * 2 along with this work; if not, write to the Free Software Foundation,
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    20  *
    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    22  * or visit www.oracle.com if you need additional information or have any
    23  * questions.
    24  */
    26 package com.sun.tools.javadoc;
    28 import com.sun.javadoc.*;
    30 import com.sun.tools.javac.code.Symbol.ClassSymbol;
    31 import com.sun.tools.javac.code.Type;
    32 import com.sun.tools.javac.util.List;
    35 /**
    36  * Implementation of <code>WildcardType</code>, which
    37  * represents a wildcard type.
    38  *
    39  *  <p><b>This is NOT part of any supported API.
    40  *  If you write code that depends on this, you do so at your own risk.
    41  *  This code and its internal interfaces are subject to change or
    42  *  deletion without notice.</b>
    43  *
    44  * @author Scott Seligman
    45  * @since 1.5
    46  */
    47 public class WildcardTypeImpl extends AbstractTypeImpl implements WildcardType {
    49     WildcardTypeImpl(DocEnv env, Type.WildcardType type) {
    50         super(env, type);
    51     }
    53     /**
    54      * Return the upper bounds of this wildcard type argument
    55      * as given by the <i>extends</i> clause.
    56      * Return an empty array if no such bounds are explicitly given.
    57      */
    58     public com.sun.javadoc.Type[] extendsBounds() {
    59         return TypeMaker.getTypes(env, getExtendsBounds((Type.WildcardType)type));
    60     }
    62     /**
    63      * Return the lower bounds of this wildcard type argument
    64      * as given by the <i>super</i> clause.
    65      * Return an empty array if no such bounds are explicitly given.
    66      */
    67     public com.sun.javadoc.Type[] superBounds() {
    68         return TypeMaker.getTypes(env, getSuperBounds((Type.WildcardType)type));
    69     }
    71     /**
    72      * Return the ClassDoc of the erasure of this wildcard type.
    73      */
    74     @Override
    75     public ClassDoc asClassDoc() {
    76         return env.getClassDoc((ClassSymbol)env.types.erasure(type).tsym);
    77     }
    79     @Override
    80     public WildcardType asWildcardType() {
    81         return this;
    82     }
    84     @Override
    85     public String typeName()            { return "?"; }
    86     @Override
    87     public String qualifiedTypeName()   { return "?"; }
    88     @Override
    89     public String simpleTypeName()      { return "?"; }
    91     @Override
    92     public String toString() {
    93         return wildcardTypeToString(env, (Type.WildcardType)type, true);
    94     }
    97     /**
    98      * Return the string form of a wildcard type ("?") along with any
    99      * "extends" or "super" clause.  Delimiting brackets are not
   100      * included.  Class names are qualified if "full" is true.
   101      */
   102     static String wildcardTypeToString(DocEnv env,
   103                                        Type.WildcardType wildThing, boolean full) {
   104         if (env.legacyDoclet) {
   105             return TypeMaker.getTypeName(env.types.erasure(wildThing), full);
   106         }
   107         StringBuilder s = new StringBuilder("?");
   108         List<Type> bounds = getExtendsBounds(wildThing);
   109         if (bounds.nonEmpty()) {
   110             s.append(" extends ");
   111         } else {
   112             bounds = getSuperBounds(wildThing);
   113             if (bounds.nonEmpty()) {
   114                 s.append(" super ");
   115             }
   116         }
   117         boolean first = true;   // currently only one bound is allowed
   118         for (Type b : bounds) {
   119             if (!first) {
   120                 s.append(" & ");
   121             }
   122             s.append(TypeMaker.getTypeString(env, b, full));
   123             first = false;
   124         }
   125         return s.toString();
   126     }
   128     private static List<Type> getExtendsBounds(Type.WildcardType wild) {
   129         return wild.isSuperBound()
   130                 ? List.<Type>nil()
   131                 : List.of(wild.type);
   132     }
   134     private static List<Type> getSuperBounds(Type.WildcardType wild) {
   135         return wild.isExtendsBound()
   136                 ? List.<Type>nil()
   137                 : List.of(wild.type);
   138     }
   139 }

mercurial