OpenJDK 27 · javax.lang.model.type.TypeMirror · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public < the return type of the visitor's methods R, the type of the additional parameter to the visitor's methods P> R	Returns: a visitor-specified result accept(TypeVisitor<R, P> the visitor operating on this type v, P additional parameter to the visitor p) Applies a visitor to this type.
public boolean	Returns: `true` if the specified object is equal to this one equals(Object the object to be compared with this type obj) Obeys the general contract of `Object.equals`.
public <A extends Annotation> A	getAnnotation(Class<A> annotationType) Redeclares javax.lang.model.AnnotatedConstruct.getAnnotation. Returns this construct's annotation of the specified type if such an annotation is present, else `null`.
public List<? extends AnnotationMirror>	getAnnotationMirrors() Redeclares javax.lang.model.AnnotatedConstruct.getAnnotationMirrors. Returns the annotations that are directly present on this construct.
public <A extends Annotation> A[]	getAnnotationsByType(Class<A> annotationType) Redeclares javax.lang.model.AnnotatedConstruct.getAnnotationsByType. Returns annotations of the specified type that are associated with this construct.
public TypeKind	Returns: the `kind` of this type getKind() Returns the `kind` of this type.
public int	hashCode() Obeys the general contract of `Object.hashCode`.
public String	Returns: a string representation of this type toString() Returns an informative string representation of this type.

Method Detail

accept	back to summary
public <R, P> R accept(TypeVisitor<R, P> v, P p) Applies a visitor to this type. Parameters <R> the return type of the visitor's methods <P> the type of the additional parameter to the visitor's methods v:TypeVisitor<R, P> the visitor operating on this type p:P additional parameter to the visitor Returns:R a visitor-specified result

back to summary

public <R, P> R accept(TypeVisitor<R, P> v, P p)

Applies a visitor to this type.

Parameters

<R>: the return type of the visitor's methods
<P>: the type of the additional parameter to the visitor's methods
v:TypeVisitor<R, P>: the visitor operating on this type
p:P: additional parameter to the visitor

Returns:R

a visitor-specified result

equals back to summary

equals	back to summary
public boolean equals(Object obj) Obeys the general contract of `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. API Note The identity of a `TypeMirror` involves implicit state not directly accessible from its methods, including state about the presence of unrelated types. `TypeMirror` objects created by different implementations of these interfaces should not be expected to compare as equal even if "the same" type is being modeled; this is analogous to the inequality of `Class` objects for the same class file loaded through different class loaders. Parameters obj:Object the object to be compared with this type Returns:boolean `true` if the specified object is equal to this one

public boolean equals(Object obj)

Obeys the general contract of 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.

API Note

The identity of a TypeMirror involves implicit state not directly accessible from its methods, including state about the presence of unrelated types. TypeMirror objects created by different implementations of these interfaces should not be expected to compare as equal even if "the same" type is being modeled; this is analogous to the inequality of Class objects for the same class file loaded through different class loaders.

Parameters

obj:Object: the object to be compared with this type

Returns:boolean

true if the specified object is equal to this one

getAnnotation back to summary

getAnnotation	back to summary
public <A extends Annotation> A getAnnotation(Class<A> annotationType) Redeclares javax.lang.model.AnnotatedConstruct.getAnnotation. Doc from javax.lang.model.AnnotatedConstruct.getAnnotation. Returns this construct's annotation of the specified type if such an annotation is present, else `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. Annotations @Override Since 1.8

public <A extends Annotation> A getAnnotation(Class<A> annotationType)

Redeclares javax.lang.model.AnnotatedConstruct.getAnnotation.

Doc from javax.lang.model.AnnotatedConstruct.getAnnotation.

Returns this construct's annotation of the specified type if such an annotation is present, else 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.

Annotations

@Override

Since

1.8

getAnnotationMirrors	back to summary
public List<? extends AnnotationMirror> getAnnotationMirrors() Redeclares javax.lang.model.AnnotatedConstruct.getAnnotationMirrors. Doc from javax.lang.model.AnnotatedConstruct.getAnnotationMirrors. Returns the annotations that are directly present on this construct. Note that any annotations returned by this method are type annotations. Annotations @Override Since 1.8

getAnnotationMirrors

back to summary

public List<? extends AnnotationMirror> getAnnotationMirrors()

Redeclares javax.lang.model.AnnotatedConstruct.getAnnotationMirrors.

Doc from javax.lang.model.AnnotatedConstruct.getAnnotationMirrors.

Returns the annotations that are directly present on this construct.

Note that any annotations returned by this method are type annotations.

Annotations

@Override

Since

1.8

getAnnotationsByType back to summary

getAnnotationsByType	back to summary
public <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType) Redeclares javax.lang.model.AnnotatedConstruct.getAnnotationsByType. Doc from javax.lang.model.AnnotatedConstruct.getAnnotationsByType. Returns annotations of the specified type that are associated with this construct. If there are no annotations of the specified type 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 and `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. Annotations @Override Since 1.8

public <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType)

Redeclares javax.lang.model.AnnotatedConstruct.getAnnotationsByType.

Doc from javax.lang.model.AnnotatedConstruct.getAnnotationsByType.

Returns annotations of the specified type that are associated with this construct. If there are no annotations of the specified type 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 and 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

Note that any annotations returned by this method are type annotations.

Annotations

@Override

Since

1.8

getKind back to summary

getKind	back to summary
public TypeKind getKind() Returns the `kind` of this type. The kind of a primitive type is one of the kinds for which `TypeKind#isPrimitive` returns `true`. 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`, or `NONE`. The kind of a union type is `UNION`. The kind of an intersection type is `INTERSECTION`. Returns:TypeKind the `kind` of this type

public TypeKind getKind()

Returns the kind of this type.

The kind of a primitive type is one of the kinds for which TypeKind#isPrimitive returns true.
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, or NONE.
The kind of a union type is UNION.
The kind of an intersection type is INTERSECTION.

Returns:TypeKind: the kind of this type

hashCode back to summary

hashCode	back to summary
public int hashCode() Obeys the general contract of `Object.hashCode`. See Also `equals`

public int hashCode()

Obeys the general contract of Object.hashCode.

See Also: equals

toString	back to summary
public 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. Returns:String a string representation of this type

toString

back to summary

public 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.

Returns:String: a string representation of this type

public Interface TypeMirror

Method Summary

Method Detail