1 /* |
|
2 * Copyright (c) 2001, 2013, 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 */ |
|
25 |
|
26 package com.sun.tools.javadoc; |
|
27 |
|
28 import com.sun.javadoc.*; |
|
29 |
|
30 /** |
|
31 * <p><b>This is NOT part of any supported API. |
|
32 * If you write code that depends on this, you do so at your own risk. |
|
33 * This code and its internal interfaces are subject to change or |
|
34 * deletion without notice.</b> |
|
35 */ |
|
36 class PrimitiveType implements com.sun.javadoc.Type { |
|
37 |
|
38 private final String name; |
|
39 |
|
40 static final PrimitiveType voidType = new PrimitiveType("void"); |
|
41 static final PrimitiveType booleanType = new PrimitiveType("boolean"); |
|
42 static final PrimitiveType byteType = new PrimitiveType("byte"); |
|
43 static final PrimitiveType charType = new PrimitiveType("char"); |
|
44 static final PrimitiveType shortType = new PrimitiveType("short"); |
|
45 static final PrimitiveType intType = new PrimitiveType("int"); |
|
46 static final PrimitiveType longType = new PrimitiveType("long"); |
|
47 static final PrimitiveType floatType = new PrimitiveType("float"); |
|
48 static final PrimitiveType doubleType = new PrimitiveType("double"); |
|
49 |
|
50 // error type, should never actually be used |
|
51 static final PrimitiveType errorType = new PrimitiveType(""); |
|
52 |
|
53 PrimitiveType(String name) { |
|
54 this.name = name; |
|
55 } |
|
56 |
|
57 /** |
|
58 * Return unqualified name of type excluding any dimension information. |
|
59 * <p> |
|
60 * For example, a two dimensional array of String returns 'String'. |
|
61 */ |
|
62 public String typeName() { |
|
63 return name; |
|
64 } |
|
65 |
|
66 public com.sun.javadoc.Type getElementType() { |
|
67 return null; |
|
68 } |
|
69 |
|
70 /** |
|
71 * Return qualified name of type excluding any dimension information. |
|
72 *<p> |
|
73 * For example, a two dimensional array of String |
|
74 * returns 'java.lang.String'. |
|
75 */ |
|
76 public String qualifiedTypeName() { |
|
77 return name; |
|
78 } |
|
79 |
|
80 /** |
|
81 * Return the simple name of this type. |
|
82 */ |
|
83 public String simpleTypeName() { |
|
84 return name; |
|
85 } |
|
86 |
|
87 /** |
|
88 * Return the type's dimension information, as a string. |
|
89 * <p> |
|
90 * For example, a two dimensional array of String returns '[][]'. |
|
91 */ |
|
92 public String dimension() { |
|
93 return ""; |
|
94 } |
|
95 |
|
96 /** |
|
97 * Return this type as a class. Array dimensions are ignored. |
|
98 * |
|
99 * @return a ClassDocImpl if the type is a Class. |
|
100 * Return null if it is a primitive type.. |
|
101 */ |
|
102 public ClassDoc asClassDoc() { |
|
103 return null; |
|
104 } |
|
105 |
|
106 /** |
|
107 * Return null, as this is not an annotation type. |
|
108 */ |
|
109 public AnnotationTypeDoc asAnnotationTypeDoc() { |
|
110 return null; |
|
111 } |
|
112 |
|
113 /** |
|
114 * Return null, as this is not an instantiation. |
|
115 */ |
|
116 public ParameterizedType asParameterizedType() { |
|
117 return null; |
|
118 } |
|
119 |
|
120 /** |
|
121 * Return null, as this is not a type variable. |
|
122 */ |
|
123 public TypeVariable asTypeVariable() { |
|
124 return null; |
|
125 } |
|
126 |
|
127 /** |
|
128 * Return null, as this is not a wildcard type. |
|
129 */ |
|
130 public WildcardType asWildcardType() { |
|
131 return null; |
|
132 } |
|
133 |
|
134 /** |
|
135 * Return null, as this is not an annotated type. |
|
136 */ |
|
137 public AnnotatedType asAnnotatedType() { |
|
138 return null; |
|
139 } |
|
140 |
|
141 /** |
|
142 * Returns a string representation of the type. |
|
143 * |
|
144 * Return name of type including any dimension information. |
|
145 * <p> |
|
146 * For example, a two dimensional array of String returns |
|
147 * <code>String[][]</code>. |
|
148 * |
|
149 * @return name of type including any dimension information. |
|
150 */ |
|
151 public String toString() { |
|
152 return qualifiedTypeName(); |
|
153 } |
|
154 |
|
155 /** |
|
156 * Return true if this is a primitive type. |
|
157 */ |
|
158 public boolean isPrimitive() { |
|
159 return true; |
|
160 } |
|
161 } |
|