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

AnnotationValueVisitor

public interface AnnotationValueVisitor
A visitor of the values of annotation type elements, using a variant of the visitor design pattern. Unlike a standard visitor which dispatches based on the concrete type of a member of a type hierarchy, this visitor dispatches based on the type of data stored; there are no distinct subclasses for storing, for example, {@code boolean} values versus {@code int} values. Classes implementing this interface are used to operate on a value when the type of that value is unknown at compile time. When a visitor is passed to a value's {@link AnnotationValue#accept accept} method, the visitXYZ method applicable to that value 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
param

the type of the additional parameter to this visitor's methods.

author
Joseph D. Darcy
author
Scott Seligman
author
Peter von der Ahé
version
1.6 06/07/31
since
1.6

Fields Summary
Constructors Summary
Methods Summary
public Rvisit(javax.lang.model.element.AnnotationValue av, P p)
Visits an annotation value.

param
av the value to visit
param
p a visitor-specified parameter
return
a visitor-specified result

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

param
av the value to visit
return
a visitor-specified result

public RvisitAnnotation(javax.lang.model.element.AnnotationMirror a, P p)
Visits an annotation value in an annotation.

param
a the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitArray(java.util.List vals, P p)
Visits an array value in an annotation.

param
vals the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitBoolean(boolean b, P p)
Visits a {@code boolean} value in an annotation.

param
b the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitByte(byte b, P p)
Visits a {@code byte} value in an annotation.

param
b the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitChar(char c, P p)
Visits a {@code char} value in an annotation.

param
c the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitDouble(double d, P p)
Visits a {@code double} value in an annotation.

param
d the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitEnumConstant(javax.lang.model.element.VariableElement c, P p)
Visits an {@code enum} value in an annotation.

param
c the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitFloat(float f, P p)
Visits a {@code float} value in an annotation.

param
f the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitInt(int i, P p)
Visits an {@code int} value in an annotation.

param
i the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitLong(long i, P p)
Visits a {@code long} value in an annotation.

param
i the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitShort(short s, P p)
Visits a {@code short} value in an annotation.

param
s the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitString(java.lang.String s, P p)
Visits a string value in an annotation.

param
s the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitType(javax.lang.model.type.TypeMirror t, P p)
Visits a type value in an annotation.

param
t the value being visited
param
p a visitor-specified parameter
return
the result of the visit

public RvisitUnknown(javax.lang.model.element.AnnotationValue av, P p)
Visits an unknown kind of annotation value. This can occur if the language evolves and new kinds of value can be stored in an annotation.

param
av the unknown value being visited
param
p a visitor-specified parameter
return
the result of the visit
throws
UnknownAnnotationValueException a visitor implementation may optionally throw this exception