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>
A visitor of types, in the style of the
visitor design pattern. Classes implementing this
interface are used to operate on a type when the kind of
type is unknown at compile time. When a visitor is passed to a
type's 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.
Method Summary | |
---|---|
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 |
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 |
visitUnknown(TypeMirror t,
P p)
Visits an unknown kind of type. |
R |
visitWildcard(WildcardType t,
P p)
Visits a wildcard type. |
Method Detail |
---|
R visit(TypeMirror t, P p)
t
- the type to visitp
- a visitor-specified parameter
R visit(TypeMirror t)
v.visit(t, null)
.
t
- the element to visit
R visitPrimitive(PrimitiveType t, P p)
t
- the type to visitp
- a visitor-specified parameter
R visitNull(NullType t, P p)
t
- the type to visitp
- a visitor-specified parameter
R visitArray(ArrayType t, P p)
t
- the type to visitp
- a visitor-specified parameter
R visitDeclared(DeclaredType t, P p)
t
- the type to visitp
- a visitor-specified parameter
R visitError(ErrorType t, P p)
t
- the type to visitp
- a visitor-specified parameter
R visitTypeVariable(TypeVariable t, P p)
t
- the type to visitp
- a visitor-specified parameter
R visitWildcard(WildcardType t, P p)
t
- the type to visitp
- a visitor-specified parameter
R visitExecutable(ExecutableType t, P p)
t
- the type to visitp
- a visitor-specified parameter
R visitNoType(NoType t, P p)
NoType
instance.
t
- the type to visitp
- a visitor-specified parameter
R visitUnknown(TypeMirror t, P p)
TypeMirror
hierarchy.
t
- the type to visitp
- a visitor-specified parameter
UnknownTypeException
- a visitor implementation may optionally throw this exception