- All Superinterfaces:
AnnotatedConstruct
- All Known Subinterfaces:
ArrayType
,DeclaredType
,ErrorType
,ExecutableType
,IntersectionType
,NoType
,NullType
,PrimitiveType
,ReferenceType
,TypeVariable
,UnionType
,WildcardType
public interface TypeMirror extends AnnotatedConstruct
void
.
Types should be compared using the utility methods in Types
. There is no guarantee that any particular type will always
be represented by the same object.
To implement operations based on the class of an
TypeMirror
object, either use a visitor
or use the result of the getKind()
method. Using
instanceof
is not necessarily a reliable idiom for
determining the effective class of an object in this modeling
hierarchy since an implementation may choose to have a single
object implement multiple TypeMirror
subinterfaces.
-
Method Summary
Modifier and Type Method Description <R, P> R
accept(TypeVisitor<R,P> v, P p)
Applies a visitor to this type.boolean
equals(Object obj)
Obeys the general contract ofObject.equals
.<A extends Annotation>
AgetAnnotation(Class<A> annotationType)
Returns this construct's annotation of the specified type if such an annotation is present, elsenull
.List<? extends AnnotationMirror>
getAnnotationMirrors()
Returns the annotations that are directly present on this construct.<A extends Annotation>
A[]getAnnotationsByType(Class<A> annotationType)
Returns annotations that are associated with this construct.TypeKind
getKind()
Returns thekind
of this type.int
hashCode()
Obeys the general contract ofObject.hashCode
.String
toString()
Returns an informative string representation of this type.
-
Method Details
-
getKind
TypeKind getKind()Returns thekind
of this type.- The kind of a primitive type is
one of the kinds for which
TypeKind.isPrimitive()
returnstrue
. - The kind of a null type is
NULL
. - The kind of an array type is
ARRAY
. - The kind of a declared type is
DECLARED
. - The kind of an error type is
ERROR
. - The kind of a type variable is
TYPEVAR
. - The kind of a wildcard type is
WILDCARD
. - The kind of an executable type
is
EXECUTABLE
. - The kind of a pseudo-type is one
of
VOID
,PACKAGE
,MODULE
, orNONE
. - The kind of a union type is
UNION
. - The kind of an intersection
type is
INTERSECTION
.
- Returns:
- the kind of this type
- The kind of a primitive type is
one of the kinds for which
-
equals
Obeys the general contract ofObject.equals
. This method does not, however, indicate whether two types represent the same type. Semantic comparisons of type equality should instead useTypes.isSameType(TypeMirror, TypeMirror)
. The results oft1.equals(t2)
andTypes.isSameType(t1, t2)
may differ.- Overrides:
equals
in classObject
- Parameters:
obj
- the object to be compared with this type- Returns:
true
if the specified object is equal to this one- See Also:
Object.hashCode()
,HashMap
-
hashCode
int hashCode()Obeys the general contract ofObject.hashCode
.- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object.
- See Also:
equals(java.lang.Object)
-
toString
String toString()Returns an informative string representation of this type. If possible, the string should be of a form suitable for representing this type in source code. Any names embedded in the result are qualified if possible. -
getAnnotationMirrors
List<? extends AnnotationMirror> getAnnotationMirrors()Returns the annotations that are directly present on this construct.Note that any annotations returned by this method are type annotations.
- Specified by:
getAnnotationMirrors
in interfaceAnnotatedConstruct
- Returns:
- the annotations directly present on this construct; an empty list if there are none
- Since:
- 8
-
getAnnotation
Returns this construct's annotation of the specified type if such an annotation is present, elsenull
.The annotation returned by this method could contain an element whose value is of type
Class
. This value cannot be returned directly: information necessary to locate and load a class (such as the class loader to use) is not available, and the class might not be loadable at all. Attempting to read aClass
object by invoking the relevant method on the returned annotation will result in aMirroredTypeException
, from which the correspondingTypeMirror
may be extracted. Similarly, attempting to read aClass[]
-valued element will result in aMirroredTypesException
.Note: This method is unlike others in this and related interfaces. It operates on runtime reflective information — representations of annotation types currently loaded into the VM — rather than on the representations defined by and used throughout these interfaces. Consequently, calling methods on the returned annotation object can throw many of the exceptions that can be thrown when calling methods on an annotation object returned by core reflection. This method is intended for callers that are written to operate on a known, fixed set of annotation types.
Note that any annotation returned by this method is a type annotation.
- Specified by:
getAnnotation
in interfaceAnnotatedConstruct
- Type Parameters:
A
- the annotation type- Parameters:
annotationType
- theClass
object corresponding to the annotation type- Returns:
- this construct's annotation for the specified
annotation type if present, else
null
- Since:
- 8
- See Also:
AnnotatedConstruct.getAnnotationMirrors()
,AnnotatedElement.getAnnotation(java.lang.Class<T>)
,EnumConstantNotPresentException
,AnnotationTypeMismatchException
,IncompleteAnnotationException
,MirroredTypeException
,MirroredTypesException
-
getAnnotationsByType
Returns annotations that are associated with this construct. If there are no annotations associated with this construct, the return value is an array of length 0. The order of annotations which are directly or indirectly present on a construct C is computed as if indirectly present annotations on C are directly present on C in place of their container annotation, in the order in which they appear in the value element of the container annotation. The difference between this method andAnnotatedConstruct.getAnnotation(Class)
is that this method detects if its argument is a repeatable annotation type, and if so, attempts to find one or more annotations of that type by "looking through" a container annotation.The annotations returned by this method could contain an element whose value is of type
Class
. This value cannot be returned directly: information necessary to locate and load a class (such as the class loader to use) is not available, and the class might not be loadable at all. Attempting to read aClass
object by invoking the relevant method on the returned annotation will result in aMirroredTypeException
, from which the correspondingTypeMirror
may be extracted. Similarly, attempting to read aClass[]
-valued element will result in aMirroredTypesException
.Note: This method is unlike others in this and related interfaces. It operates on runtime reflective information — representations of annotation types currently loaded into the VM — rather than on the representations defined by and used throughout these interfaces. Consequently, calling methods on the returned annotation object can throw many of the exceptions that can be thrown when calling methods on an annotation object returned by core reflection. This method is intended for callers that are written to operate on a known, fixed set of annotation types.
Note that any annotations returned by this method are type annotations.
- Specified by:
getAnnotationsByType
in interfaceAnnotatedConstruct
- Type Parameters:
A
- the annotation type- Parameters:
annotationType
- theClass
object corresponding to the annotation type- Returns:
- this construct's annotations for the specified annotation type if present on this construct, else an empty array
- Since:
- 8
- See Also:
AnnotatedConstruct.getAnnotationMirrors()
,AnnotatedConstruct.getAnnotation(Class)
,AnnotatedElement.getAnnotationsByType(Class)
,EnumConstantNotPresentException
,AnnotationTypeMismatchException
,IncompleteAnnotationException
,MirroredTypeException
,MirroredTypesException
-
accept
Applies a visitor to this type.- Type Parameters:
R
- the return type of the visitor's methodsP
- the type of the additional parameter to the visitor's methods- Parameters:
v
- the visitor operating on this typep
- additional parameter to the visitor- Returns:
- a visitor-specified result
-