R
- the return type of this visitor's methodsP
- the type of the additional parameter to this visitor's methods.public interface AnnotationValueVisitor<R,P>
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, boolean
values versus 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 accept
method, the visitXYZ
method applicable to that value 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.
Note that methods to accommodate new language constructs could be added in a source compatible way if they were added as default methods. However, default methods are only available on Java SE 8 and higher releases and the javax.lang.model.*
packages bundled in Java SE 8 are required to also be runnable on Java SE 7. Therefore, default methods cannot be used when extending javax.lang.model.*
to cover Java SE 8 language features. However, default methods may be used in subsequent revisions of the javax.lang.model.*
packages that are only required to run on Java SE 8 and higher platform versions.
R visit(AnnotationValue av, P p)
Visits an annotation value.
av
- the value to visitp
- a visitor-specified parameterR visit(AnnotationValue av)
A convenience method equivalent to v.visit(av, null)
.
av
- the value to visitR visitBoolean(boolean b, P p)
Visits a boolean
value in an annotation.
b
- the value being visitedp
- a visitor-specified parameterR visitByte(byte b, P p)
Visits a byte
value in an annotation.
b
- the value being visitedp
- a visitor-specified parameterR visitChar(char c, P p)
Visits a char
value in an annotation.
c
- the value being visitedp
- a visitor-specified parameterR visitDouble(double d, P p)
Visits a double
value in an annotation.
d
- the value being visitedp
- a visitor-specified parameterR visitFloat(float f, P p)
Visits a float
value in an annotation.
f
- the value being visitedp
- a visitor-specified parameterR visitInt(int i, P p)
Visits an int
value in an annotation.
i
- the value being visitedp
- a visitor-specified parameterR visitLong(long i, P p)
Visits a long
value in an annotation.
i
- the value being visitedp
- a visitor-specified parameterR visitShort(short s, P p)
Visits a short
value in an annotation.
s
- the value being visitedp
- a visitor-specified parameterR visitString(String s, P p)
Visits a string value in an annotation.
s
- the value being visitedp
- a visitor-specified parameterR visitType(TypeMirror t, P p)
Visits a type value in an annotation.
t
- the value being visitedp
- a visitor-specified parameterR visitEnumConstant(VariableElement c, P p)
Visits an enum
value in an annotation.
c
- the value being visitedp
- a visitor-specified parameterR visitAnnotation(AnnotationMirror a, P p)
Visits an annotation value in an annotation.
a
- the value being visitedp
- a visitor-specified parameterR visitArray(List<? extends AnnotationValue> vals, P p)
Visits an array value in an annotation.
vals
- the value being visitedp
- a visitor-specified parameterR visitUnknown(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.
av
- the unknown value being visitedp
- a visitor-specified parameterUnknownAnnotationValueException
- a visitor implementation may optionally throw this exception
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.