Liking cljdoc? Tell your friends :D

javax.lang.model.element.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, 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.

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.
raw docstring

visitclj

(visit this av)
(visit this av p)

Visits an annotation value.

av - the value to visit - javax.lang.model.element.AnnotationValue p - a visitor-specified parameter - P

returns: a visitor-specified result - R

Visits an annotation value.

av - the value to visit - `javax.lang.model.element.AnnotationValue`
p - a visitor-specified parameter - `P`

returns: a visitor-specified result - `R`
raw docstring

visit-annotationclj

(visit-annotation this a p)

Visits an annotation value in an annotation.

a - the value being visited - javax.lang.model.element.AnnotationMirror p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits an annotation value in an annotation.

a - the value being visited - `javax.lang.model.element.AnnotationMirror`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-arrayclj

(visit-array this vals p)

Visits an array value in an annotation.

vals - the value being visited - java.util.List p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits an array value in an annotation.

vals - the value being visited - `java.util.List`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-booleanclj

(visit-boolean this b p)

Visits a boolean value in an annotation.

b - the value being visited - boolean p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits a boolean value in an annotation.

b - the value being visited - `boolean`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-byteclj

(visit-byte this b p)

Visits a byte value in an annotation.

b - the value being visited - byte p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits a byte value in an annotation.

b - the value being visited - `byte`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-charclj

(visit-char this c p)

Visits a char value in an annotation.

c - the value being visited - char p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits a char value in an annotation.

c - the value being visited - `char`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-doubleclj

(visit-double this d p)

Visits a double value in an annotation.

d - the value being visited - double p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits a double value in an annotation.

d - the value being visited - `double`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-enum-constantclj

(visit-enum-constant this c p)

Visits an enum value in an annotation.

c - the value being visited - javax.lang.model.element.VariableElement p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits an enum value in an annotation.

c - the value being visited - `javax.lang.model.element.VariableElement`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-floatclj

(visit-float this f p)

Visits a float value in an annotation.

f - the value being visited - float p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits a float value in an annotation.

f - the value being visited - `float`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-intclj

(visit-int this i p)

Visits an int value in an annotation.

i - the value being visited - int p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits an int value in an annotation.

i - the value being visited - `int`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-longclj

(visit-long this i p)

Visits a long value in an annotation.

i - the value being visited - long p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits a long value in an annotation.

i - the value being visited - `long`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-shortclj

(visit-short this s p)

Visits a short value in an annotation.

s - the value being visited - short p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits a short value in an annotation.

s - the value being visited - `short`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-stringclj

(visit-string this s p)

Visits a string value in an annotation.

s - the value being visited - java.lang.String p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits a string value in an annotation.

s - the value being visited - `java.lang.String`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-typeclj

(visit-type this t p)

Visits a type value in an annotation.

t - the value being visited - javax.lang.model.type.TypeMirror p - a visitor-specified parameter - P

returns: the result of the visit - R

Visits a type value in an annotation.

t - the value being visited - `javax.lang.model.type.TypeMirror`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`
raw docstring

visit-unknownclj

(visit-unknown this av 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 visited - javax.lang.model.element.AnnotationValue p - a visitor-specified parameter - P

returns: the result of the visit - R

throws: javax.lang.model.element.UnknownAnnotationValueException - a visitor implementation may optionally throw this exception

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 visited - `javax.lang.model.element.AnnotationValue`
p - a visitor-specified parameter - `P`

returns: the result of the visit - `R`

throws: javax.lang.model.element.UnknownAnnotationValueException - a visitor implementation may optionally throw this exception
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close