Package gw.gosudoc.com.sun.javadoc
Interface Type
- All Known Subinterfaces:
AnnotatedType
,AnnotationTypeDoc
,ClassDoc
,ParameterizedType
,TypeVariable
,WildcardType
- All Known Implementing Classes:
AbstractTypeImpl
,AnnotatedTypeImpl
,AnnotationTypeDocImpl
,ClassDocImpl
,ParameterizedTypeImpl
,PrimitiveType
,TypeMaker.ArrayTypeImpl
,TypeVariableImpl
,WildcardTypeImpl
Deprecated.
Represents a type. A type can be a class or interface, an
invocation (like
List<String>
) of a generic class or interface,
a type variable, a wildcard type ("?
"),
or a primitive data type (like char
).- Since:
- 1.2
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Returns this type as aAnnotatedType
if it represents an annotated type.Deprecated.Return this type as anAnnotationTypeDoc
if it represents an annotation type.Deprecated.Return this type as aClassDoc
if it represents a class or interface.Deprecated.Return this type as aParameterizedType
if it represents an invocation of a generic class or interface.Deprecated.Return this type as aTypeVariable
if it represents a type variable.Deprecated.Return this type as aWildcardType
if it represents a wildcard type.Deprecated.Return the type's dimension information, as a string.Deprecated.If this type is an array type, return the element type of the array.boolean
Deprecated.Return true if this type represents a primitive type.Deprecated.Return qualified name of type excluding any dimension information.Deprecated.Return the simple name of this type excluding any dimension information.toString()
Deprecated.Return a string representation of the type.typeName()
Deprecated.Return unqualified name of type excluding any dimension information.
-
Method Details
-
typeName
String typeName()Deprecated.Return unqualified name of type excluding any dimension information.For example, a two dimensional array of String returns "
String
".- Returns:
- unqualified name of type excluding any dimension information.
-
qualifiedTypeName
String qualifiedTypeName()Deprecated.Return qualified name of type excluding any dimension information.For example, a two dimensional array of String returns "
java.lang.String
".- Returns:
- qualified name of this type excluding any dimension information.
-
simpleTypeName
String simpleTypeName()Deprecated.Return the simple name of this type excluding any dimension information. This is the unqualified name of the type, except that for nested types only the identifier of the innermost type is included.For example, the class
Outer.Inner
returns "Inner
".- Returns:
- the simple name of this type excluding any dimension information.
- Since:
- 1.5
-
dimension
String dimension()Deprecated.Return the type's dimension information, as a string.For example, a two dimensional array of String returns "
[][]
".- Returns:
- the type's dimension information as a string.
-
toString
String toString()Deprecated.Return a string representation of the type. This includes any dimension information and type arguments.For example, a two dimensional array of String may return "
java.lang.String[][]
", and the parameterized typeList<Integer>
may return "java.util.List<java.lang.Integer>
". -
isPrimitive
boolean isPrimitive()Deprecated.Return true if this type represents a primitive type.- Returns:
- true if this type represents a primitive type.
- Since:
- 1.5
-
asClassDoc
ClassDoc asClassDoc()Deprecated.Return this type as aClassDoc
if it represents a class or interface. Array dimensions are ignored. If this type is aParameterizedType
,TypeVariable
, orWildcardType
, return theClassDoc
of the type's erasure. If this is anAnnotationTypeDoc
, return this as aClassDoc
(but seeasAnnotationTypeDoc()
). If this is a primitive type, return null.- Returns:
- the
ClassDoc
of this type, or null if it is a primitive type.
-
asParameterizedType
ParameterizedType asParameterizedType()Deprecated.Return this type as aParameterizedType
if it represents an invocation of a generic class or interface. Array dimensions are ignored.- Returns:
- a
ParameterizedType
if the type is an invocation of a generic type, or null if it is not. - Since:
- 1.5
-
asTypeVariable
TypeVariable asTypeVariable()Deprecated.Return this type as aTypeVariable
if it represents a type variable. Array dimensions are ignored.- Returns:
- a
TypeVariable
if the type is a type variable, or null if it is not. - Since:
- 1.5
-
asWildcardType
WildcardType asWildcardType()Deprecated.Return this type as aWildcardType
if it represents a wildcard type.- Returns:
- a
WildcardType
if the type is a wildcard type, or null if it is not. - Since:
- 1.5
-
asAnnotatedType
AnnotatedType asAnnotatedType()Deprecated.Returns this type as aAnnotatedType
if it represents an annotated type.- Returns:
- a
AnnotatedType
if the type if an annotated type, or null if it is not - Since:
- 1.8
-
asAnnotationTypeDoc
AnnotationTypeDoc asAnnotationTypeDoc()Deprecated.Return this type as anAnnotationTypeDoc
if it represents an annotation type. Array dimensions are ignored.- Returns:
- an
AnnotationTypeDoc
if the type is an annotation type, or null if it is not. - Since:
- 1.5
-
getElementType
Type getElementType()Deprecated.If this type is an array type, return the element type of the array. Otherwise, return null.- Returns:
- a
Type
representing the element type or null. - Since:
- 1.8
-
jdk.javadoc.doclet
. For more information, see the Migration Guide in the documentation for that package.