duke@1: /*
jjg@1521:  * Copyright (c) 2001, 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@1359: /**
jjg@1359:  *  <p><b>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.</b>
jjg@1359:  */
duke@1: class PrimitiveType implements com.sun.javadoc.Type {
duke@1: 
duke@1:     private final String name;
duke@1: 
duke@1:     static final PrimitiveType voidType = new PrimitiveType("void");
duke@1:     static final PrimitiveType booleanType = new PrimitiveType("boolean");
duke@1:     static final PrimitiveType byteType = new PrimitiveType("byte");
duke@1:     static final PrimitiveType charType = new PrimitiveType("char");
duke@1:     static final PrimitiveType shortType = new PrimitiveType("short");
duke@1:     static final PrimitiveType intType = new PrimitiveType("int");
duke@1:     static final PrimitiveType longType = new PrimitiveType("long");
duke@1:     static final PrimitiveType floatType = new PrimitiveType("float");
duke@1:     static final PrimitiveType doubleType = new PrimitiveType("double");
duke@1: 
duke@1:     // error type, should never actually be used
duke@1:     static final PrimitiveType errorType = new PrimitiveType("");
duke@1: 
duke@1:     PrimitiveType(String name) {
duke@1:         this.name = name;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return unqualified name of type excluding any dimension information.
duke@1:      * <p>
duke@1:      * For example, a two dimensional array of String returns 'String'.
duke@1:      */
duke@1:     public String typeName() {
duke@1:         return name;
duke@1:     }
duke@1: 
bpatel@1691:     public com.sun.javadoc.Type getElementType() {
bpatel@1691:         return null;
bpatel@1691:     }
bpatel@1691: 
duke@1:     /**
duke@1:      * Return qualified name of type excluding any dimension information.
duke@1:      *<p>
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 name;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the simple name of this type.
duke@1:      */
duke@1:     public String simpleTypeName() {
duke@1:         return name;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the type's dimension information, as a string.
duke@1:      * <p>
duke@1:      * For example, a two dimensional array of String returns '[][]'.
duke@1:      */
duke@1:     public String dimension() {
duke@1:         return "";
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 null;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return null, as this is not an annotation type.
duke@1:      */
duke@1:     public AnnotationTypeDoc asAnnotationTypeDoc() {
duke@1:         return null;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return null, as this is not an instantiation.
duke@1:      */
duke@1:     public ParameterizedType asParameterizedType() {
duke@1:         return null;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return null, as this is not a type variable.
duke@1:      */
duke@1:     public TypeVariable asTypeVariable() {
duke@1:         return null;
duke@1:     }
duke@1: 
duke@1:     /**
jjg@1521:      * Return null, as this is not a wildcard type.
duke@1:      */
duke@1:     public WildcardType asWildcardType() {
duke@1:         return null;
duke@1:     }
duke@1: 
duke@1:     /**
jjg@1521:      * Return null, as this is not an annotated type.
jjg@1521:      */
jjg@1521:     public AnnotatedType asAnnotatedType() {
jjg@1521:         return null;
jjg@1521:     }
jjg@1521: 
jjg@1521:     /**
duke@1:      * Returns a string representation of the type.
duke@1:      *
duke@1:      * Return name of type including any dimension information.
duke@1:      * <p>
duke@1:      * For example, a two dimensional array of String returns
duke@1:      * <code>String[][]</code>.
duke@1:      *
duke@1:      * @return name of type including any dimension information.
duke@1:      */
duke@1:     public String toString() {
duke@1:         return qualifiedTypeName();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this is a primitive type.
duke@1:      */
duke@1:     public boolean isPrimitive() {
duke@1:         return true;
duke@1:     }
duke@1: }