FileDocCategorySizeDatePackage
ElementVisitor.javaAPI DocJava SE 6 API4027Tue Jun 10 00:26:10 BST 2008javax.lang.model.element

ElementVisitor

public interface ElementVisitor
A visitor of program elements, in the style of the visitor design pattern. Classes implementing this interface are used to operate on an element when the kind of element is unknown at compile time. When a visitor is passed to an element's {@link Element#accept accept} method, the visitXYZ method most applicable to that element 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.4 06/07/31
see
AbstractElementVisitor6
since
1.6

Fields Summary
Constructors Summary
Methods Summary
public Rvisit(javax.lang.model.element.Element e, P p)
Visits an element.

param
e the element to visit
param
p a visitor-specified parameter
return
a visitor-specified result

public Rvisit(javax.lang.model.element.Element e)
A convenience method equivalent to {@code v.visit(e, null)}.

param
e the element to visit
return
a visitor-specified result

public RvisitExecutable(javax.lang.model.element.ExecutableElement e, P p)
Visits an executable element.

param
e the element to visit
param
p a visitor-specified parameter
return
a visitor-specified result

public RvisitPackage(javax.lang.model.element.PackageElement e, P p)
Visits a package element.

param
e the element to visit
param
p a visitor-specified parameter
return
a visitor-specified result

public RvisitType(javax.lang.model.element.TypeElement e, P p)
Visits a type element.

param
e the element to visit
param
p a visitor-specified parameter
return
a visitor-specified result

public RvisitTypeParameter(javax.lang.model.element.TypeParameterElement e, P p)
Visits a type parameter element.

param
e the element to visit
param
p a visitor-specified parameter
return
a visitor-specified result

public RvisitUnknown(javax.lang.model.element.Element e, P p)
Visits an unknown kind of element. This can occur if the language evolves and new kinds of elements are added to the {@code Element} hierarchy.

param
e the element to visit
param
p a visitor-specified parameter
return
a visitor-specified result
throws
UnknownElementException a visitor implementation may optionally throw this exception

public RvisitVariable(javax.lang.model.element.VariableElement e, P p)
Visits a variable element.

param
e the element to visit
param
p a visitor-specified parameter
return
a visitor-specified result