Interface Types

Element asElement(TypeMirror t)

Returns the element corresponding to a type. The type may be a DeclaredType or TypeVariable. Returns null if the type is not one with a corresponding element.

boolean isSameType(TypeMirror t1, TypeMirror t2)

Tests whether two 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.

boolean isSubtype(TypeMirror t1, TypeMirror t2)

Tests whether one type is a subtype of another. Any type is considered to be a subtype of itself.

boolean isAssignable(TypeMirror t1, TypeMirror t2)

Tests whether one type is assignable to another.

boolean contains(TypeMirror t1, TypeMirror t2)

Tests whether one type argument contains another.

boolean isSubsignature(ExecutableType m1, ExecutableType m2)

Tests whether the signature of one method is a subsignature of another.

List<? extends TypeMirror> directSupertypes(TypeMirror t)

Returns the direct supertypes of a type. The interface types, if any, will appear last in the list. For an interface type with no direct super-interfaces, a type mirror representing java.lang.Object is returned.

TypeMirror erasure(TypeMirror t)

Returns the erasure of a type.

TypeElement boxedClass(PrimitiveType p)

Returns the class of a boxed value of the primitive type argument. That is, boxing conversion is applied.

PrimitiveType unboxedType(TypeMirror t)

Returns the type (a primitive type) of unboxed values of a given type. That is, unboxing conversion is applied.

TypeMirror capture(TypeMirror t)

Applies capture conversion to a type.

PrimitiveType getPrimitiveType(TypeKind kind)

Returns a primitive type.

NullType getNullType()

Returns the null type. This is the type of null.

NoType getNoType(TypeKind kind)

Returns a pseudo-type used where no actual type is appropriate. The kind of type to return may be either VOID or NONE.

To get the pseudo-type corresponding to a package or module, call asType() on the element modeling the package or module. Names can be converted to elements for packages or modules using Elements.getPackageElement(CharSequence) or Elements.getModuleElement(CharSequence), respectively.

ArrayType getArrayType(TypeMirror componentType)

Returns an array type with the specified component type.

WildcardType getWildcardType(TypeMirror extendsBound, TypeMirror superBound)

Returns a new wildcard type. Either of the wildcard's bounds may be specified, or neither, but not both.

DeclaredType getDeclaredType(TypeElement typeElem, TypeMirror... typeArgs)

Returns the type corresponding to a type element and actual type arguments. Given the type element for 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...).

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. The parameterized type 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).

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. For example, when viewed as a member of the parameterized type Set<String>, the Set.add method is an ExecutableType whose parameter is of type String.