duke@1: /* jjg@1521: * Copyright (c) 1997, 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: 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.Type; jjg@1357: import com.sun.tools.javac.code.Type.ArrayType; duke@1: import com.sun.tools.javac.code.Type.ClassType; duke@1: import com.sun.tools.javac.code.Type.TypeVar; duke@1: import com.sun.tools.javac.util.List; jjg@1374: import static com.sun.tools.javac.code.TypeTag.ARRAY; duke@1: jjg@1359: /** 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: public class TypeMaker {
duke@1:
duke@1: public static com.sun.javadoc.Type getType(DocEnv env, Type t) {
duke@1: return getType(env, t, true);
duke@1: }
duke@1:
duke@1: /**
duke@1: * @param errToClassDoc if true, ERROR type results in a ClassDoc;
duke@1: * false preserves legacy behavior
duke@1: */
jjg@1521: public static com.sun.javadoc.Type getType(DocEnv env, Type t,
jjg@1521: boolean errorToClassDoc) {
jjg@1521: return getType(env, t, errorToClassDoc, true);
jjg@1521: }
jjg@1521:
jjg@198: @SuppressWarnings("fallthrough")
duke@1: public static com.sun.javadoc.Type getType(DocEnv env, Type t,
jjg@1521: boolean errToClassDoc, boolean considerAnnotations) {
duke@1: if (env.legacyDoclet) {
duke@1: t = env.types.erasure(t);
duke@1: }
jjg@1521:
jjg@1992: if (considerAnnotations && t.isAnnotated()) {
jjg@1992: return new AnnotatedTypeImpl(env, t);
jjg@1521: }
jjg@1521:
jjg@1374: switch (t.getTag()) {
duke@1: case CLASS:
duke@1: if (ClassDocImpl.isGeneric((ClassSymbol)t.tsym)) {
duke@1: return env.getParameterizedType((ClassType)t);
duke@1: } else {
duke@1: return env.getClassDoc((ClassSymbol)t.tsym);
duke@1: }
duke@1: case WILDCARD:
duke@1: Type.WildcardType a = (Type.WildcardType)t;
duke@1: return new WildcardTypeImpl(env, a);
duke@1: case TYPEVAR: return new TypeVariableImpl(env, (TypeVar)t);
duke@1: case ARRAY: return new ArrayTypeImpl(env, t);
duke@1: case BYTE: return PrimitiveType.byteType;
duke@1: case CHAR: return PrimitiveType.charType;
duke@1: case SHORT: return PrimitiveType.shortType;
duke@1: case INT: return PrimitiveType.intType;
duke@1: case LONG: return PrimitiveType.longType;
duke@1: case FLOAT: return PrimitiveType.floatType;
duke@1: case DOUBLE: return PrimitiveType.doubleType;
duke@1: case BOOLEAN: return PrimitiveType.booleanType;
duke@1: case VOID: return PrimitiveType.voidType;
duke@1: case ERROR:
duke@1: if (errToClassDoc)
duke@1: return env.getClassDoc((ClassSymbol)t.tsym);
duke@1: // FALLTHRU
duke@1: default:
duke@1: return new PrimitiveType(t.tsym.getQualifiedName().toString());
duke@1: }
duke@1: }
duke@1:
duke@1: /**
duke@1: * Convert a list of javac types into an array of javadoc types.
duke@1: */
duke@1: public static com.sun.javadoc.Type[] getTypes(DocEnv env, List
duke@1: * For example, a two dimensional array of String returns '[][]'.
duke@1: */
duke@1: public String dimension() {
jjg@910: StringBuilder dimension = new StringBuilder();
jjg@1374: for (Type t = arrayType; t.hasTag(ARRAY); t = env.types.elemtype(t)) {
jjg@910: dimension.append("[]");
duke@1: }
duke@1: return dimension.toString();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return unqualified name of type excluding any dimension information.
duke@1: *
duke@1: * For example, a two dimensional array of String returns 'String'.
duke@1: */
duke@1: public String typeName() {
duke@1: return skipArrays().typeName();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return qualified name of type excluding any dimension information.
duke@1: *
duke@1: * For example, a two dimensional array of String
duke@1: * returns 'java.lang.String'.
duke@1: */
duke@1: public String qualifiedTypeName() {
duke@1: return skipArrays().qualifiedTypeName();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the simple name of this type excluding any dimension information.
duke@1: */
duke@1: public String simpleTypeName() {
duke@1: return skipArrays().simpleTypeName();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return this type as a class. Array dimensions are ignored.
duke@1: *
duke@1: * @return a ClassDocImpl if the type is a Class.
duke@1: * Return null if it is a primitive type..
duke@1: */
duke@1: public ClassDoc asClassDoc() {
duke@1: return skipArrays().asClassDoc();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return this type as a
duke@1: * For example, a two dimensional array of String returns
duke@1: * ParameterizedType
if it
duke@1: * represents a parameterized type. Array dimensions are ignored.
duke@1: */
duke@1: public ParameterizedType asParameterizedType() {
duke@1: return skipArrays().asParameterizedType();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return this type as a TypeVariable
if it represents
duke@1: * a type variable. Array dimensions are ignored.
duke@1: */
duke@1: public TypeVariable asTypeVariable() {
duke@1: return skipArrays().asTypeVariable();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return null, as there are no arrays of wildcard types.
duke@1: */
duke@1: public WildcardType asWildcardType() {
duke@1: return null;
duke@1: }
duke@1:
duke@1: /**
jjg@1521: * Return null, as there are no annotations of the type
jjg@1521: */
jjg@1521: public AnnotatedType asAnnotatedType() {
jjg@1521: return null;
jjg@1521: }
jjg@1521:
jjg@1521: /**
duke@1: * Return this type as an AnnotationTypeDoc
if it
duke@1: * represents an annotation type. Array dimensions are ignored.
duke@1: */
duke@1: public AnnotationTypeDoc asAnnotationTypeDoc() {
duke@1: return skipArrays().asAnnotationTypeDoc();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return true if this is an array of a primitive type.
duke@1: */
duke@1: public boolean isPrimitive() {
duke@1: return skipArrays().isPrimitive();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return a string representation of the type.
duke@1: *
duke@1: * Return name of type including any dimension information.
duke@1: * String[][]
.
duke@1: *
duke@1: * @return name of type including any dimension information.
duke@1: */
jjg@910: @Override
duke@1: public String toString() {
duke@1: return qualifiedTypeName() + dimension();
duke@1: }
duke@1: }
duke@1: }