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

Thu, 31 Aug 2017 15:17:03 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:17:03 +0800
changeset 2525
2eb010b6cb22
parent 1691
f10cffab99b4
parent 0
959103a6100f
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.tools.javadoc;
aoqi@0 27
aoqi@0 28 import com.sun.javadoc.*;
aoqi@0 29
aoqi@0 30 /**
aoqi@0 31 * <p><b>This is NOT part of any supported API.
aoqi@0 32 * If you write code that depends on this, you do so at your own risk.
aoqi@0 33 * This code and its internal interfaces are subject to change or
aoqi@0 34 * deletion without notice.</b>
aoqi@0 35 */
aoqi@0 36 class PrimitiveType implements com.sun.javadoc.Type {
aoqi@0 37
aoqi@0 38 private final String name;
aoqi@0 39
aoqi@0 40 static final PrimitiveType voidType = new PrimitiveType("void");
aoqi@0 41 static final PrimitiveType booleanType = new PrimitiveType("boolean");
aoqi@0 42 static final PrimitiveType byteType = new PrimitiveType("byte");
aoqi@0 43 static final PrimitiveType charType = new PrimitiveType("char");
aoqi@0 44 static final PrimitiveType shortType = new PrimitiveType("short");
aoqi@0 45 static final PrimitiveType intType = new PrimitiveType("int");
aoqi@0 46 static final PrimitiveType longType = new PrimitiveType("long");
aoqi@0 47 static final PrimitiveType floatType = new PrimitiveType("float");
aoqi@0 48 static final PrimitiveType doubleType = new PrimitiveType("double");
aoqi@0 49
aoqi@0 50 // error type, should never actually be used
aoqi@0 51 static final PrimitiveType errorType = new PrimitiveType("");
aoqi@0 52
aoqi@0 53 PrimitiveType(String name) {
aoqi@0 54 this.name = name;
aoqi@0 55 }
aoqi@0 56
aoqi@0 57 /**
aoqi@0 58 * Return unqualified name of type excluding any dimension information.
aoqi@0 59 * <p>
aoqi@0 60 * For example, a two dimensional array of String returns 'String'.
aoqi@0 61 */
aoqi@0 62 public String typeName() {
aoqi@0 63 return name;
aoqi@0 64 }
aoqi@0 65
aoqi@0 66 public com.sun.javadoc.Type getElementType() {
aoqi@0 67 return null;
aoqi@0 68 }
aoqi@0 69
aoqi@0 70 /**
aoqi@0 71 * Return qualified name of type excluding any dimension information.
aoqi@0 72 *<p>
aoqi@0 73 * For example, a two dimensional array of String
aoqi@0 74 * returns 'java.lang.String'.
aoqi@0 75 */
aoqi@0 76 public String qualifiedTypeName() {
aoqi@0 77 return name;
aoqi@0 78 }
aoqi@0 79
aoqi@0 80 /**
aoqi@0 81 * Return the simple name of this type.
aoqi@0 82 */
aoqi@0 83 public String simpleTypeName() {
aoqi@0 84 return name;
aoqi@0 85 }
aoqi@0 86
aoqi@0 87 /**
aoqi@0 88 * Return the type's dimension information, as a string.
aoqi@0 89 * <p>
aoqi@0 90 * For example, a two dimensional array of String returns '[][]'.
aoqi@0 91 */
aoqi@0 92 public String dimension() {
aoqi@0 93 return "";
aoqi@0 94 }
aoqi@0 95
aoqi@0 96 /**
aoqi@0 97 * Return this type as a class. Array dimensions are ignored.
aoqi@0 98 *
aoqi@0 99 * @return a ClassDocImpl if the type is a Class.
aoqi@0 100 * Return null if it is a primitive type..
aoqi@0 101 */
aoqi@0 102 public ClassDoc asClassDoc() {
aoqi@0 103 return null;
aoqi@0 104 }
aoqi@0 105
aoqi@0 106 /**
aoqi@0 107 * Return null, as this is not an annotation type.
aoqi@0 108 */
aoqi@0 109 public AnnotationTypeDoc asAnnotationTypeDoc() {
aoqi@0 110 return null;
aoqi@0 111 }
aoqi@0 112
aoqi@0 113 /**
aoqi@0 114 * Return null, as this is not an instantiation.
aoqi@0 115 */
aoqi@0 116 public ParameterizedType asParameterizedType() {
aoqi@0 117 return null;
aoqi@0 118 }
aoqi@0 119
aoqi@0 120 /**
aoqi@0 121 * Return null, as this is not a type variable.
aoqi@0 122 */
aoqi@0 123 public TypeVariable asTypeVariable() {
aoqi@0 124 return null;
aoqi@0 125 }
aoqi@0 126
aoqi@0 127 /**
aoqi@0 128 * Return null, as this is not a wildcard type.
aoqi@0 129 */
aoqi@0 130 public WildcardType asWildcardType() {
aoqi@0 131 return null;
aoqi@0 132 }
aoqi@0 133
aoqi@0 134 /**
aoqi@0 135 * Return null, as this is not an annotated type.
aoqi@0 136 */
aoqi@0 137 public AnnotatedType asAnnotatedType() {
aoqi@0 138 return null;
aoqi@0 139 }
aoqi@0 140
aoqi@0 141 /**
aoqi@0 142 * Returns a string representation of the type.
aoqi@0 143 *
aoqi@0 144 * Return name of type including any dimension information.
aoqi@0 145 * <p>
aoqi@0 146 * For example, a two dimensional array of String returns
aoqi@0 147 * <code>String[][]</code>.
aoqi@0 148 *
aoqi@0 149 * @return name of type including any dimension information.
aoqi@0 150 */
aoqi@0 151 public String toString() {
aoqi@0 152 return qualifiedTypeName();
aoqi@0 153 }
aoqi@0 154
aoqi@0 155 /**
aoqi@0 156 * Return true if this is a primitive type.
aoqi@0 157 */
aoqi@0 158 public boolean isPrimitive() {
aoqi@0 159 return true;
aoqi@0 160 }
aoqi@0 161 }

mercurial