R
- the return type of this visitor's methodsP
- the type of the additional parameter to this visitor's methods.AbstractAnnotationValueVisitor14
, AbstractAnnotationValueVisitor6
, AbstractAnnotationValueVisitor7
, AbstractAnnotationValueVisitor8
, AbstractAnnotationValueVisitor9
, SimpleAnnotationValueVisitor14
, SimpleAnnotationValueVisitor6
, SimpleAnnotationValueVisitor7
, SimpleAnnotationValueVisitor8
, SimpleAnnotationValueVisitor9
public interface AnnotationValueVisitor<R,P>
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.
Methods to accommodate new language constructs are expected to be added as default methods to provide strong source compatibility, as done for visitModule
in ElementVisitor
. The implementations of the default methods in this interface 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 FooVisitor
N where N indicates the source version the visitor is appropriate for. In particular, a FooVisitor
N 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),
FooVisitor
N may also handle that later source version; in that case, the SupportedSourceVersion
annotation on the
FooVisitor
N class will indicate a later version. When visiting an annotation value representing a language construct introduced after source version N, a
FooVisitor
N will throw an UnknownAnnotationValueException
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:
AbstractAnnotationValueVisitor
s: Skeletal visitor implementations. SimpleAnnotationValueVisitor
s: Support default actions and a default return value. Modifier and Type | Method | Description |
---|---|---|
default R |
visit |
A convenience method equivalent to visit(av, null) . |
R |
visit |
Visits an annotation value. |
R |
visitAnnotation |
Visits an annotation value in an annotation. |
R |
visitArray |
Visits an array value in an annotation. |
R |
visitBoolean |
Visits a boolean value in an annotation. |
R |
visitByte |
Visits a byte value in an annotation. |
R |
visitChar |
Visits a char value in an annotation. |
R |
visitDouble |
Visits a double value in an annotation. |
R |
visitEnumConstant |
Visits an enum value in an annotation. |
R |
visitFloat |
Visits a float value in an annotation. |
R |
visitInt |
Visits an int value in an annotation. |
R |
visitLong |
Visits a long value in an annotation. |
R |
visitShort |
Visits a short value in an annotation. |
R |
visitString |
Visits a string value in an annotation. |
R |
visitType |
Visits a type value in an annotation. |
R |
visitUnknown |
Visits an unknown kind of annotation value. |
R visit(AnnotationValue av, P p)
av
- the value to visitp
- a visitor-specified parameterdefault R visit(AnnotationValue av)
visit(av, null)
.visit(av, null)
.av
- the value to visitR visitBoolean(boolean b, P p)
boolean
value in an annotation.b
- the value being visitedp
- a visitor-specified parameterR visitByte(byte b, P p)
byte
value in an annotation.b
- the value being visitedp
- a visitor-specified parameterR visitChar(char c, P p)
char
value in an annotation.c
- the value being visitedp
- a visitor-specified parameterR visitDouble(double d, P p)
double
value in an annotation.d
- the value being visitedp
- a visitor-specified parameterR visitFloat(float f, P p)
float
value in an annotation.f
- the value being visitedp
- a visitor-specified parameterR visitInt(int i, P p)
int
value in an annotation.i
- the value being visitedp
- a visitor-specified parameterR visitLong(long i, P p)
long
value in an annotation.i
- the value being visitedp
- a visitor-specified parameterR visitShort(short s, P p)
short
value in an annotation.s
- the value being visitedp
- a visitor-specified parameterR visitString(String s, P p)
s
- the value being visitedp
- a visitor-specified parameterR visitType(TypeMirror t, P p)
t
- the value being visitedp
- a visitor-specified parameterR visitEnumConstant(VariableElement c, P p)
enum
value in an annotation.c
- the value being visitedp
- a visitor-specified parameterR visitAnnotation(AnnotationMirror a, P p)
a
- the value being visitedp
- a visitor-specified parameterR visitArray(List<? extends AnnotationValue> vals, P p)
vals
- the value being visitedp
- a visitor-specified parameterR visitUnknown(AnnotationValue av, P p)
av
- the unknown value being visitedp
- a visitor-specified parameterUnknownAnnotationValueException
- a visitor implementation may optionally throw this exception
© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.compiler/javax/lang/model/element/AnnotationValueVisitor.html