public interface Types
Compatibility Note: Methods may be added to this interface in future releases of the platform.
ProcessingEnvironment.getTypeUtils()
Modifier and Type | Method and Description |
---|---|
Element |
asElement(TypeMirror t)
Returns the element corresponding to a type.
|
TypeMirror |
asMemberOf(DeclaredType containing,
Element element)
Returns the type of an element when that element is viewed as
a member of, or otherwise directly contained by, a given type.
|
TypeElement |
boxedClass(PrimitiveType p)
Returns the class of a boxed value of a given primitive type.
|
TypeMirror |
capture(TypeMirror t)
Applies capture conversion to a type.
|
boolean |
contains(TypeMirror t1,
TypeMirror t2)
Tests whether one type argument contains another.
|
List<? extends TypeMirror> |
directSupertypes(TypeMirror t)
Returns the direct supertypes of a type.
|
TypeMirror |
erasure(TypeMirror t)
Returns the erasure of a type.
|
ArrayType |
getArrayType(TypeMirror componentType)
Returns an array type with the specified component type.
|
DeclaredType |
getDeclaredType(DeclaredType containing,
TypeElement typeElem,
TypeMirror... typeArgs)
Returns the type corresponding to a type element
and actual type arguments, given a
containing type
of which it is a member.
|
DeclaredType |
getDeclaredType(TypeElement typeElem,
TypeMirror... typeArgs)
Returns the type corresponding to a type element and
actual type arguments.
|
NoType |
getNoType(TypeKind kind)
Returns a pseudo-type used where no actual type is appropriate.
|
NullType |
getNullType()
Returns the null type.
|
PrimitiveType |
getPrimitiveType(TypeKind kind)
Returns a primitive type.
|
WildcardType |
getWildcardType(TypeMirror extendsBound,
TypeMirror superBound)
Returns a new wildcard type argument.
|
boolean |
isAssignable(TypeMirror t1,
TypeMirror t2)
Tests whether one type is assignable to another.
|
boolean |
isSameType(TypeMirror t1,
TypeMirror t2)
Tests whether two
TypeMirror objects represent the same type. |
boolean |
isSubsignature(ExecutableType m1,
ExecutableType m2)
Tests whether the signature of one method is a subsignature
of another.
|
boolean |
isSubtype(TypeMirror t1,
TypeMirror t2)
Tests whether one type is a subtype of another.
|
PrimitiveType |
unboxedType(TypeMirror t)
Returns the type (a primitive type) of unboxed values of a given type.
|
Element asElement(TypeMirror t)
DeclaredType
or TypeVariable
.
Returns null
if the type is not one with a
corresponding element.t
- the type to map to an elementboolean isSameType(TypeMirror t1, TypeMirror t2)
TypeMirror
objects represent the same type.
Caveat: if either of the arguments to this method represents a wildcard, this method will return false. As a consequence, a wildcard is not the same type as itself. This might be surprising at first, but makes sense once you consider that an example like this must be rejected by the compiler:
List<?> list = new ArrayList<Object>();
list.add(list.get(0));
Since annotations are only meta-data associated with a type,
the set of annotations on either argument is not taken
into account when computing whether or not two TypeMirror
objects are the same type. In particular, two
TypeMirror
objects can have different annotations and
still be considered the same.
t1
- the first typet2
- the second typetrue
if and only if the two types are the sameboolean isSubtype(TypeMirror t1, TypeMirror t2)
t1
- the first typet2
- the second typetrue
if and only if the first type is a subtype
of the secondIllegalArgumentException
- if given an executable or package typeboolean isAssignable(TypeMirror t1, TypeMirror t2)
t1
- the first typet2
- the second typetrue
if and only if the first type is assignable
to the secondIllegalArgumentException
- if given an executable or package typeboolean contains(TypeMirror t1, TypeMirror t2)
t1
- the first typet2
- the second typetrue
if and only if the first type contains the secondIllegalArgumentException
- if given an executable or package typeboolean isSubsignature(ExecutableType m1, ExecutableType m2)
m1
- the first methodm2
- the second methodtrue
if and only if the first signature is a
subsignature of the secondList<? extends TypeMirror> directSupertypes(TypeMirror t)
t
- the type being examinedIllegalArgumentException
- if given an executable or package typeTypeMirror erasure(TypeMirror t)
t
- the type to be erasedIllegalArgumentException
- if given a package typeTypeElement boxedClass(PrimitiveType p)
p
- the primitive type to be convertedp
PrimitiveType unboxedType(TypeMirror t)
t
- the type to be unboxedt
IllegalArgumentException
- if the given type has no
unboxing conversionTypeMirror capture(TypeMirror t)
t
- the type to be convertedIllegalArgumentException
- if given an executable or package typePrimitiveType getPrimitiveType(TypeKind kind)
kind
- the kind of primitive type to returnIllegalArgumentException
- if kind
is not a primitive kindNullType getNullType()
null
.NoType getNoType(TypeKind kind)
VOID
or NONE
.
For packages, use
Elements.getPackageElement(CharSequence)
.asType()
instead.kind
- the kind of type to returnVOID
or NONE
IllegalArgumentException
- if kind
is not validArrayType getArrayType(TypeMirror componentType)
componentType
- the component typeIllegalArgumentException
- if the component type is not valid for
an arrayWildcardType getWildcardType(TypeMirror extendsBound, TypeMirror superBound)
extendsBound
- the extends (upper) bound, or null
if nonesuperBound
- the super (lower) bound, or null
if noneIllegalArgumentException
- if bounds are not validDeclaredType getDeclaredType(TypeElement typeElem, TypeMirror... typeArgs)
Set
and the type mirror
for String
,
for example, this method may be used to get the
parameterized type Set<String>
.
The number of type arguments must either equal the number of the type element's formal type parameters, or must be zero. If zero, and if the type element is generic, then the type element's raw type is returned.
If a parameterized type is being returned, its type element
must not be contained within a generic outer class.
The parameterized type Outer<String>.Inner<Number>
,
for example, may be constructed by first using this
method to get the type Outer<String>
, and then invoking
getDeclaredType(DeclaredType, TypeElement, TypeMirror...)
.
typeElem
- the type elementtypeArgs
- the actual type argumentsIllegalArgumentException
- if too many or too few
type arguments are given, or if an inappropriate type
argument or type element is providedDeclaredType getDeclaredType(DeclaredType containing, TypeElement typeElem, TypeMirror... typeArgs)
Outer<String>.Inner<Number>
,
for example, may be constructed by first using
getDeclaredType(TypeElement, TypeMirror...)
to get the type Outer<String>
, and then invoking
this method.
If the containing type is a parameterized type,
the number of type arguments must equal the
number of typeElem
's formal type parameters.
If it is not parameterized or if it is null
, this method is
equivalent to getDeclaredType(typeElem, typeArgs)
.
containing
- the containing type, or null
if nonetypeElem
- the type elementtypeArgs
- the actual type argumentsIllegalArgumentException
- if too many or too few
type arguments are given, or if an inappropriate type
argument, type element, or containing type is providedTypeMirror asMemberOf(DeclaredType containing, Element element)
Set<String>
,
the Set.add
method is an ExecutableType
whose parameter is of type String
.containing
- the containing typeelement
- the elementIllegalArgumentException
- if the element is not a valid one
for the given type Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved.