R
- the return type of this visitor's methods. Use Void
for visitors that do not need to return results.P
- the type of the additional parameter to this visitor's
methods. Use Void
for visitors that do not need an
additional parameter.public interface TypeVisitor<R,P>
accept
method, the visitXYZ
method most applicable to that type is invoked.
Classes implementing this interface may or may not throw a
NullPointerException
if the additional parameter p
is null
; see documentation of the implementing class for
details.
WARNING: It is possible that methods will be added to this interface to accommodate new, currently unknown, language structures added to future versions of the Java™ programming language. Therefore, visitor classes directly implementing this interface may be source incompatible with future versions of the platform. To avoid this source incompatibility, visitor implementations are encouraged to instead extend the appropriate abstract visitor class that implements this interface. However, an API should generally use this visitor interface as the type for parameters, return type, etc. rather than one of the abstract classes.
Note that methods to accommodate new language constructs could
be added in a source compatible way if they were added as
default methods. However, default methods are only
available on Java SE 8 and higher releases and the javax.lang.model.*
packages bundled in Java SE 8 are required to
also be runnable on Java SE 7. Therefore, default methods
cannot be used when extending javax.lang.model.*
to cover Java SE 8 language features. However, default methods may
be used in subsequent revisions of the javax.lang.model.*
packages that are only required to run on Java SE 8 and higher
platform versions.
Modifier and Type | Method and Description |
---|---|
R |
visit(TypeMirror t)
A convenience method equivalent to
v.visit(t, null) . |
R |
visit(TypeMirror t,
P p)
Visits a type.
|
R |
visitArray(ArrayType t,
P p)
Visits an array type.
|
R |
visitDeclared(DeclaredType t,
P p)
Visits a declared type.
|
R |
visitError(ErrorType t,
P p)
Visits an error type.
|
R |
visitExecutable(ExecutableType t,
P p)
Visits an executable type.
|
R |
visitIntersection(IntersectionType t,
P p)
Visits an intersection type.
|
R |
visitNoType(NoType t,
P p)
Visits a
NoType instance. |
R |
visitNull(NullType t,
P p)
Visits the null type.
|
R |
visitPrimitive(PrimitiveType t,
P p)
Visits a primitive type.
|
R |
visitTypeVariable(TypeVariable t,
P p)
Visits a type variable.
|
R |
visitUnion(UnionType t,
P p)
Visits a union type.
|
R |
visitUnknown(TypeMirror t,
P p)
Visits an unknown kind of type.
|
R |
visitWildcard(WildcardType t,
P p)
Visits a wildcard type.
|
R visit(TypeMirror t, P p)
t
- the type to visitp
- a visitor-specified parameterR visit(TypeMirror t)
v.visit(t, null)
.t
- the element to visitR visitPrimitive(PrimitiveType t, P p)
t
- the type to visitp
- a visitor-specified parameterR visitNull(NullType t, P p)
t
- the type to visitp
- a visitor-specified parameterR visitArray(ArrayType t, P p)
t
- the type to visitp
- a visitor-specified parameterR visitDeclared(DeclaredType t, P p)
t
- the type to visitp
- a visitor-specified parameterR visitError(ErrorType t, P p)
t
- the type to visitp
- a visitor-specified parameterR visitTypeVariable(TypeVariable t, P p)
t
- the type to visitp
- a visitor-specified parameterR visitWildcard(WildcardType t, P p)
t
- the type to visitp
- a visitor-specified parameterR visitExecutable(ExecutableType t, P p)
t
- the type to visitp
- a visitor-specified parameterR visitNoType(NoType t, P p)
NoType
instance.t
- the type to visitp
- a visitor-specified parameterR visitUnknown(TypeMirror t, P p)
TypeMirror
hierarchy.t
- the type to visitp
- a visitor-specified parameterUnknownTypeException
- a visitor implementation may optionally throw this exceptionR visitUnion(UnionType t, P p)
t
- the type to visitp
- a visitor-specified parameterR visitIntersection(IntersectionType t, P p)
t
- the type to visitp
- a visitor-specified parameter Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2023, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.