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.
API Note
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. Such additions have already occurred in another visitor interface in this package to support language features added after this API was introduced. 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.
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
FooVisitorN where N indicates the
source version the
visitor is appropriate for.
In particular, a FooVisitorN 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), FooVisitorN may also handle that later source version; in
that case, the SupportedSourceVersion annotation on the FooVisitorN class will indicate a later version.
When visiting an annotation value representing a language construct
introduced after source version N, a FooVisitorN 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:
AbstractAnnotationValueVisitors: Skeletal visitor implementations.
SimpleAnnotationValueVisitors: Support default actions and a
default return value.
| Modifier and Type | Method and Description |
|---|---|
| public R | Returns: a visitor-specified resultthe value to visit av, P a visitor-specified parameter p)Visits an annotation value. |
| public default R | Returns: a visitor-specified resultthe value to visit av)A convenience method equivalent to |
| public R | Returns: the result of the visitthe value being visited a, P a visitor-specified parameter p)Visits an annotation value in an annotation. |
| public R | Returns: the result of the visitthe value being visited vals, P a visitor-specified parameter p)Visits an array value in an annotation. |
| public R | Returns: the result of the visitthe value being visited b, P a visitor-specified parameter p)Visits a |
| public R | Returns: the result of the visitthe value being visited b, P a visitor-specified parameter p)Visits a |
| public R | Returns: the result of the visitthe value being visited c, P a visitor-specified parameter p)Visits a |
| public R | Returns: the result of the visitthe value being visited d, P a visitor-specified parameter p)Visits a |
| public R | Returns: the result of the visitthe value being visited c, P a visitor-specified parameter p)Visits an |
| public R | Returns: the result of the visitthe value being visited f, P a visitor-specified parameter p)Visits a |
| public R | Returns: the result of the visitthe value being visited i, P a visitor-specified parameter p)Visits an |
| public R | Returns: the result of the visitthe value being visited i, P a visitor-specified parameter p)Visits a |
| public R | Returns: the result of the visitthe value being visited s, P a visitor-specified parameter p)Visits a |
| public R | Returns: the result of the visitthe value being visited s, P a visitor-specified parameter p)Visits a string value in an annotation. |
| public R | Returns: the result of the visitthe value being visited t, P a visitor-specified parameter p)Visits a type value in an annotation. |
| public R | Returns: the result of the visitthe unknown value being visited av, P a visitor-specified parameter p)Visits an unknown kind of annotation value. |
| visit | back to summary |
|---|---|
| public R visit(AnnotationValue av, P p) Visits an annotation value.
| |
| visit | back to summary |
|---|---|
| public default R visit(AnnotationValue av) A convenience method equivalent to Implementation Specification The default implementation is
| |
| visitAnnotation | back to summary |
|---|---|
| public R visitAnnotation(AnnotationMirror a, P p) Visits an annotation value in an annotation.
| |
| visitArray | back to summary |
|---|---|
| public R visitArray(List<? extends AnnotationValue> vals, P p) Visits an array value in an annotation.
| |
| visitBoolean | back to summary |
|---|---|
| public R visitBoolean(boolean b, P p) Visits a
| |
| visitByte | back to summary |
|---|---|
| public R visitByte(byte b, P p) Visits a
| |
| visitChar | back to summary |
|---|---|
| public R visitChar(char c, P p) Visits a
| |
| visitDouble | back to summary |
|---|---|
| public R visitDouble(double d, P p) Visits a
| |
| visitEnumConstant | back to summary |
|---|---|
| public R visitEnumConstant(VariableElement c, P p) Visits an
| |
| visitFloat | back to summary |
|---|---|
| public R visitFloat(float f, P p) Visits a
| |
| visitInt | back to summary |
|---|---|
| public R visitInt(int i, P p) Visits an
| |
| visitLong | back to summary |
|---|---|
| public R visitLong(long i, P p) Visits a
| |
| visitShort | back to summary |
|---|---|
| public R visitShort(short s, P p) Visits a
| |
| visitString | back to summary |
|---|---|
| public R visitString(String s, P p) Visits a string value in an annotation.
| |
| visitType | back to summary |
|---|---|
| public R visitType(TypeMirror t, P p) Visits a type value in an annotation.
| |
| visitUnknown | back to summary |
|---|---|
| public R 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.
| |