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

Fri, 11 Jun 2010 17:24:23 -0700

author
jjg
date
Fri, 11 Jun 2010 17:24:23 -0700
changeset 584
d1ea43cb71c1
parent 554
9d9f26857129
child 910
ebf7c13df6c0
permissions
-rw-r--r--

6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
Reviewed-by: darcy

     1 /*
     2  * Copyright (c) 2003, 2005, 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;
    29 import com.sun.javadoc.*;
    31 import static com.sun.javadoc.LanguageVersion.*;
    33 import com.sun.tools.javac.code.Symbol.ClassSymbol;
    34 import com.sun.tools.javac.code.Type;
    35 import com.sun.tools.javac.util.List;
    38 /**
    39  * Implementation of <code>WildcardType</code>, which
    40  * represents a wildcard type.
    41  *
    42  * @author Scott Seligman
    43  * @since 1.5
    44  */
    45 public class WildcardTypeImpl extends AbstractTypeImpl implements WildcardType {
    47     WildcardTypeImpl(DocEnv env, Type.WildcardType type) {
    48         super(env, type);
    49     }
    51     /**
    52      * Return the upper bounds of this wildcard type argument
    53      * as given by the <i>extends</i> clause.
    54      * Return an empty array if no such bounds are explicitly given.
    55      */
    56     public com.sun.javadoc.Type[] extendsBounds() {
    57         return TypeMaker.getTypes(env, getExtendsBounds((Type.WildcardType)type));
    58     }
    60     /**
    61      * Return the lower bounds of this wildcard type argument
    62      * as given by the <i>super</i> clause.
    63      * Return an empty array if no such bounds are explicitly given.
    64      */
    65     public com.sun.javadoc.Type[] superBounds() {
    66         return TypeMaker.getTypes(env, getSuperBounds((Type.WildcardType)type));
    67     }
    69     /**
    70      * Return the ClassDoc of the erasure of this wildcard type.
    71      */
    72     public ClassDoc asClassDoc() {
    73         return env.getClassDoc((ClassSymbol)env.types.erasure(type).tsym);
    74     }
    76     public WildcardType asWildcardType() {
    77         return this;
    78     }
    80     public String typeName()            { return "?"; }
    81     public String qualifiedTypeName()   { return "?"; }
    82     public String simpleTypeName()      { return "?"; }
    84     public String toString() {
    85         return wildcardTypeToString(env, (Type.WildcardType)type, true);
    86     }
    89     /**
    90      * Return the string form of a wildcard type ("?") along with any
    91      * "extends" or "super" clause.  Delimiting brackets are not
    92      * included.  Class names are qualified if "full" is true.
    93      */
    94     static String wildcardTypeToString(DocEnv env,
    95                                        Type.WildcardType wildThing, boolean full) {
    96         if (env.legacyDoclet) {
    97             return TypeMaker.getTypeName(env.types.erasure(wildThing), full);
    98         }
    99         StringBuffer s = new StringBuffer("?");
   100         List<Type> bounds = getExtendsBounds(wildThing);
   101         if (bounds.nonEmpty()) {
   102             s.append(" extends ");
   103         } else {
   104             bounds = getSuperBounds(wildThing);
   105             if (bounds.nonEmpty()) {
   106                 s.append(" super ");
   107             }
   108         }
   109         boolean first = true;   // currently only one bound is allowed
   110         for (Type b : bounds) {
   111             if (!first) {
   112                 s.append(" & ");
   113             }
   114             s.append(TypeMaker.getTypeString(env, b, full));
   115             first = false;
   116         }
   117         return s.toString();
   118     }
   120     private static List<Type> getExtendsBounds(Type.WildcardType wild) {
   121         return wild.isSuperBound()
   122                 ? List.<Type>nil()
   123                 : List.of(wild.type);
   124     }
   126     private static List<Type> getSuperBounds(Type.WildcardType wild) {
   127         return wild.isExtendsBound()
   128                 ? List.<Type>nil()
   129                 : List.of(wild.type);
   130     }
   131 }

mercurial