On this page
Interface TypeMirror
- 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.
- See Java Language Specification:
- 4.1 The Kinds of Types and Values
4.2 Primitive Types and Values
4.3 Reference Types and Values
4.4 Type Variables
4.5 Parameterized Types
4.8 Raw Types
4.9 Intersection Types
10.1 Array Types
- Since:
- 1.6
- See Also:
Method Summary
Modifier and Type | Method | Description |
---|---|---|
<R, |
accept |
Applies a visitor to this type.
|
boolean |
equals |
Obeys the general contract of Object.equals .
|
<A extends Annotation> |
getAnnotation |
Returns this construct's annotation of the specified type if such an annotation is present, else null .
|
List<? extends AnnotationMirror> |
getAnnotationMirrors() |
Returns the annotations that are directly present on this construct.
|
<A extends Annotation> |
getAnnotationsByType |
Returns annotations that are associated with this construct.
|
TypeKind |
getKind() |
Returns the kind of this type.
|
int |
hashCode() |
Obeys the general contract of Object.hashCode .
|
String |
toString() |
Returns an informative string representation of this type.
|
Method Details
getKind
TypeKind getKind()
kind
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
equals
boolean equals(Object obj)
Object.equals
. This method does not, however, indicate whether two types represent the same type. Semantic comparisons of type equality should instead use Types.isSameType(TypeMirror, TypeMirror)
. The results of t1.equals(t2)
and Types.isSameType(t1, t2)
may differ.
hashCode
int hashCode()
Object.hashCode
.
toString
String toString()
getAnnotationMirrors
List<? extends AnnotationMirror> getAnnotationMirrors()
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
<A extends Annotation> A getAnnotation(Class<A> annotationType)
null
.
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 a Class
object by invoking the relevant method on the returned annotation will result in a MirroredTypeException
, from which the corresponding TypeMirror
may be extracted. Similarly, attempting to read a Class[]
-valued element will result in a MirroredTypesException
.
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 of the specified type if such an annotation is present, else
null
- Since:
- 8
- See Also:
getAnnotationsByType
<A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType)
AnnotatedConstruct.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 a Class
object by invoking the relevant method on the returned annotation will result in a MirroredTypeException
, from which the corresponding TypeMirror
may be extracted. Similarly, attempting to read a Class[]
-valued element will result in a MirroredTypesException
.
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:
accept
<R, P> R accept(TypeVisitor<R,P> v, P p)
- 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
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/lang/model/type/TypeMirror.html