-
- All Known Subinterfaces:
- ArrayType, DeclaredType, ErrorType, ExecutableType, NoType, NullType, PrimitiveType, ReferenceType, TypeVariable, UnionType, WildcardType
public interface TypeMirror
Represents a type in the Java programming language. Types include primitive types, declared types (class and interface types), array types, type variables, and the null type. Also represented are wildcard type arguments, the signature and return types of executables, and pseudo-types corresponding to packages and to the keywordvoid
.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 thegetKind()
method. Usinginstanceof
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 multipleTypeMirror
subinterfaces.
-
-
Method Summary
Methods Modifier and Type Method and 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
.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 Detail
-
getKind
TypeKind getKind()
Returns thekind
of this type.- Returns:
- the kind of this type
-
equals
boolean equals(Object obj)
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.
-
accept
<R,P> R accept(TypeVisitor<R,P> v, P p)
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
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/lang/model/type/typemirror.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.