AnnotatedConstruct
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.
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 |
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. |
TypeKind getKind()
kind
of this type. TypeKind.isPrimitive()
returns true
. NULL
. ARRAY
. DECLARED
. ERROR
. TYPEVAR
. WILDCARD
. EXECUTABLE
. VOID
, PACKAGE
, MODULE
, or NONE
. UNION
. INTERSECTION
. kind
of this typeboolean 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.int hashCode()
Object.hashCode
.String toString()
List<? extends AnnotationMirror> getAnnotationMirrors()
Note that any annotations returned by this method are type annotations.
getAnnotationMirrors
in interface AnnotatedConstruct
<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 interfaces 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 interfaces.
Note that any annotation returned by this method is a type annotation.
getAnnotation
in interface AnnotatedConstruct
A
- the annotation interfaceannotationType
- the Class
object corresponding to the annotation interfacenull
<A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType)
AnnotatedConstruct.getAnnotation(Class)
is that this method detects if its argument is a repeatable annotation interface, 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 interfaces 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 interfaces.
Note that any annotations returned by this method are type annotations.
getAnnotationsByType
in interface AnnotatedConstruct
A
- the annotation interfaceannotationType
- the Class
object corresponding to the annotation interface<R, P> R accept(TypeVisitor<R,P> v, P p)
R
- the return type of the visitor's methodsP
- the type of the additional parameter to the visitor's methodsv
- the visitor operating on this typep
- additional parameter to the visitor
© 1993, 2023, 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/21/docs/api/java.compiler/javax/lang/model/type/TypeMirror.html