Void for visitors that do not need to return results.
Void for visitors that do not need an
additional parameter.
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.
API Note
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. Such additions have already occurred to support language features added after this API was introduced. 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.
Methods to accommodate new language constructs are expected to
be added as default methods to provide strong source
compatibility. The implementations of the default methods will in
turn call visitUnknown, behavior that will be
overridden in concrete visitors supporting the source version with
the new language construct.
There are several families of classes implementing this visitor
interface in the util
package. The families follow a naming pattern along the lines of
FooVisitorN where N indicates the
source version the
visitor is appropriate for.
In particular, a FooVisitorN is expected to handle
all language constructs present in source version N. If
there are no new language constructs added in version
N + 1 (or subsequent releases), FooVisitorN may also handle that later source version; in
that case, the SupportedSourceVersion annotation on the FooVisitorN class will indicate a later version.
When visiting a type representing a language construct
introduced after source version N, a FooVisitorN will throw an UnknownTypeException
unless that behavior is overridden.
When choosing which member of a visitor family to subclass, subclassing the most recent one increases the range of source versions covered. When choosing which visitor family to subclass, consider their built-in capabilities:
AbstractTypeVisitors:
Skeletal visitor implementations.
SimpleTypeVisitors: Support
default actions and a default return value.
TypeKindVisitors: Visit methods
provided on a per-kind granularity
as some categories of types can have more than one kind.
| Modifier and Type | Method and Description |
|---|---|
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits a type. |
| public default R | Returns: a visitor-specified resultthe element to visit t)A convenience method equivalent to |
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits an array type. |
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits a declared type. |
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits an error type. |
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits an executable type. |
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits an intersection type. |
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits a |
| public R | |
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits a primitive type. |
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits a type variable. |
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits a union type. |
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits an unknown kind of type. |
| public R | Returns: a visitor-specified resultthe type to visit t, P a visitor-specified parameter p)Visits a wildcard type. |
| visit | back to summary |
|---|---|
| public R visit(TypeMirror t, P p) Visits a type.
| |
| visit | back to summary |
|---|---|
| public default R visit(TypeMirror t) A convenience method equivalent to Implementation Specification The default implementation is
| |
| visitArray | back to summary |
|---|---|
| public R visitArray(ArrayType t, P p) Visits an array type.
| |
| visitDeclared | back to summary |
|---|---|
| public R visitDeclared(DeclaredType t, P p) Visits a declared type.
| |
| visitError | back to summary |
|---|---|
| public R visitError(ErrorType t, P p) Visits an error type.
| |
| visitExecutable | back to summary |
|---|---|
| public R visitExecutable(ExecutableType t, P p) Visits an executable type.
| |
| visitIntersection | back to summary |
|---|---|
| public R visitIntersection(IntersectionType t, P p) Visits an intersection type.
| |
| visitNoType | back to summary |
|---|---|
| public R visitNoType(NoType t, P p) Visits a
| |
| visitNull | back to summary |
|---|---|
| public R visitNull(NullType t, P p) Visits the null type.
| |
| visitPrimitive | back to summary |
|---|---|
| public R visitPrimitive(PrimitiveType t, P p) Visits a primitive type.
| |
| visitTypeVariable | back to summary |
|---|---|
| public R visitTypeVariable(TypeVariable t, P p) Visits a type variable.
| |
| visitUnion | back to summary |
|---|---|
| public R visitUnion(UnionType t, P p) Visits a union type.
| |
| visitUnknown | back to summary |
|---|---|
| public R visitUnknown(TypeMirror t, P p) Visits an unknown kind of type.
This can occur if the language evolves and new kinds
of types are added to the
| |
| visitWildcard | back to summary |
|---|---|
| public R visitWildcard(WildcardType t, P p) Visits a wildcard type.
| |