File Doc Category Size Date Package
TypeVisitor.java API Doc Java SE 6 API 4740 Tue Jun 10 00:26:10 BST 2008 javax.lang.model.type

TypeVisitor

public interface TypeVisitor

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 {@link TypeMirror#accept accept} method, the visitXYZ method most applicable to that type is invoked.

Classes implementing this interface may or may not throw a {@code NullPointerException} if the additional parameter {@code p} is {@code 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.

param: the return type of this visitor's methods. Use {@link Void} for visitors that do not need to return results.
param: the type of the additional parameter to this visitor's methods. Use {@code Void} for visitors that do not need an additional parameter.
author: Joseph D. Darcy
author: Scott Seligman
author: Peter von der Ahé
version: 1.5 06/07/31
since: 1.6

Fields Summary
Constructors Summary
Methods Summary
public R visit(javax.lang.model.type.TypeMirror t, P p)
Visits a type.
param
t the type to visit
param
p a visitor-specified parameter
return
a visitor-specified result
public R visit(javax.lang.model.type.TypeMirror t)
A convenience method equivalent to {@code v.visit(t, null)}.
param
t the element to visit
return
a visitor-specified result
public R visitArray(javax.lang.model.type.ArrayType t, P p)
Visits an array type.
param
t the type to visit
param
p a visitor-specified parameter
return
a visitor-specified result
public R visitDeclared(javax.lang.model.type.DeclaredType t, P p)
Visits a declared type.
param
t the type to visit
param
p a visitor-specified parameter
return
a visitor-specified result
public R visitError(javax.lang.model.type.ErrorType t, P p)
Visits an error type.
param
t the type to visit
param
p a visitor-specified parameter
return
a visitor-specified result
public R visitExecutable(javax.lang.model.type.ExecutableType t, P p)
Visits an executable type.
param
t the type to visit
param
p a visitor-specified parameter
return
a visitor-specified result
public R visitNoType(javax.lang.model.type.NoType t, P p)
Visits a {@link NoType} instance.
param
t the type to visit
param
p a visitor-specified parameter
return
a visitor-specified result
public R visitNull(javax.lang.model.type.NullType t, P p)
Visits the null type.
param
t the type to visit
param
p a visitor-specified parameter
return
a visitor-specified result
public R visitPrimitive(javax.lang.model.type.PrimitiveType t, P p)
Visits a primitive type.
param
t the type to visit
param
p a visitor-specified parameter
return
a visitor-specified result
public R visitTypeVariable(javax.lang.model.type.TypeVariable t, P p)
Visits a type variable.
param
t the type to visit
param
p a visitor-specified parameter
return
a visitor-specified result
public R visitUnknown(javax.lang.model.type.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 {@code TypeMirror} hierarchy.
param
t the type to visit
param
p a visitor-specified parameter
return
a visitor-specified result
throws
UnknownTypeException a visitor implementation may optionally throw this exception
public R visitWildcard(javax.lang.model.type.WildcardType t, P p)
Visits a wildcard type.
param
t the type to visit
param
p a visitor-specified parameter
return
a visitor-specified result