Package org.springframework.asm
Class AnnotationVisitor
- java.lang.Object
- org.springframework.asm.AnnotationVisitor
public abstract class AnnotationVisitor extends Object
A visitor to visit a Java annotation. The methods of this class must be called in the following order: ( visit | visitEnum | visitAnnotation | visitArray )* visitEnd.- Author:
- Eric Bruneton, Eugene Kuleshov
Field Summary
Fields Modifier and Type Field Description protected int
api
The ASM API version implemented by this visitor.protected AnnotationVisitor
av
The annotation visitor to which this visitor must delegate method calls.
Constructor Summary
Constructors Constructor Description AnnotationVisitor(int api)
Constructs a newAnnotationVisitor
.AnnotationVisitor(int api, AnnotationVisitor av)
Constructs a newAnnotationVisitor
.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
visit(String name, Object value)
Visits a primitive value of the annotation.AnnotationVisitor
visitAnnotation(String name, String desc)
Visits a nested annotation value of the annotation.AnnotationVisitor
visitArray(String name)
Visits an array value of the annotation.void
visitEnd()
Visits the end of the annotation.void
visitEnum(String name, String desc, String value)
Visits an enumeration value of the annotation.
Field Detail
api
protected final int api
The ASM API version implemented by this visitor. The value of this field must be one ofOpcodes.ASM4
,Opcodes.ASM5
orOpcodes.ASM6
.
av
protected AnnotationVisitor av
The annotation visitor to which this visitor must delegate method calls. May be null.
Constructor Detail
AnnotationVisitor
public AnnotationVisitor(int api)
Constructs a newAnnotationVisitor
.- Parameters:
api
- the ASM API version implemented by this visitor. Must be one ofOpcodes.ASM4
,Opcodes.ASM5
orOpcodes.ASM6
.
AnnotationVisitor
public AnnotationVisitor(int api, AnnotationVisitor av)
Constructs a newAnnotationVisitor
.- Parameters:
api
- the ASM API version implemented by this visitor. Must be one ofOpcodes.ASM4
,Opcodes.ASM5
orOpcodes.ASM6
.av
- the annotation visitor to which this visitor must delegate method calls. May be null.
Method Detail
visit
public void visit(String name, Object value)
Visits a primitive value of the annotation.- Parameters:
name
- the value name.value
- the actual value, whose type must beByte
,Boolean
,Character
,Short
,Integer
,Long
,Float
,Double
,String
orType
of OBJECT or ARRAY sort. This value can also be an array of byte, boolean, short, char, int, long, float or double values (this is equivalent to usingvisitArray
and visiting each array element in turn, but is more convenient).
visitEnum
public void visitEnum(String name, String desc, String value)
Visits an enumeration value of the annotation.- Parameters:
name
- the value name.desc
- the class descriptor of the enumeration class.value
- the actual enumeration value.
visitAnnotation
public AnnotationVisitor visitAnnotation(String name, String desc)
Visits a nested annotation value of the annotation.- Parameters:
name
- the value name.desc
- the class descriptor of the nested annotation class.- Returns:
- a visitor to visit the actual nested annotation value, or null if this visitor is not interested in visiting this nested annotation. The nested annotation value must be fully visited before calling other methods on this annotation visitor.
visitArray
public AnnotationVisitor visitArray(String name)
Visits an array value of the annotation. Note that arrays of primitive types (such as byte, boolean, short, char, int, long, float or double) can be passed as value tovisit
. This is whatClassReader
does.- Parameters:
name
- the value name.- Returns:
- a visitor to visit the actual array value elements, or null if this visitor is not interested in visiting these values. The 'name' parameters passed to the methods of this visitor are ignored. All the array values must be visited before calling other methods on this annotation visitor.
visitEnd
public void visitEnd()
Visits the end of the annotation.