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>
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.
Modifier and Type | Method and Description |
---|---|
R |
visit(AnnotationValue av)
A convenience method equivalent to
v.visit(av, null) . |
R |
visit(AnnotationValue av,
P p)
Visits an annotation value.
|
R |
visitAnnotation(AnnotationMirror a,
P p)
Visits an annotation value in an annotation.
|
R |
visitArray(List<? extends AnnotationValue> vals,
P p)
Visits an array value in an annotation.
|
R |
visitBoolean(boolean b,
P p)
Visits a
boolean value in an annotation. |
R |
visitByte(byte b,
P p)
Visits a
byte value in an annotation. |
R |
visitChar(char c,
P p)
Visits a
char value in an annotation. |
R |
visitDouble(double d,
P p)
Visits a
double value in an annotation. |
R |
visitEnumConstant(VariableElement c,
P p)
Visits an
enum value in an annotation. |
R |
visitFloat(float f,
P p)
Visits a
float value in an annotation. |
R |
visitInt(int i,
P p)
Visits an
int value in an annotation. |
R |
visitLong(long i,
P p)
Visits a
long value in an annotation. |
R |
visitShort(short s,
P p)
Visits a
short value in an annotation. |
R |
visitString(String s,
P p)
Visits a string value in an annotation.
|
R |
visitType(TypeMirror t,
P p)
Visits a type value in an annotation.
|
R |
visitUnknown(AnnotationValue av,
P p)
Visits an unknown kind of annotation value.
|
R visit(AnnotationValue av, P p)
av
- the value to visitp
- a visitor-specified parameterR visit(AnnotationValue av)
v.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 Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2023, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.