org.objectweb.asm
Interface AnnotationVisitor

All Known Implementing Classes:
AnnotationConstantsCollector, AnnotationNode, AnnotationWriter, ASMifierAnnotationVisitor, CheckAnnotationAdapter, EmptyVisitor, SAXAnnotationAdapter, TraceAnnotationVisitor

public interface AnnotationVisitor

A visitor to visit a Java annotation. The methods of this interface must be called in the following order: (visit | visitEnum | visitAnnotation | visitArray)* visitEnd.

Author:
Eric Bruneton, Eugene Kuleshov

Method Summary
 void visit(java.lang.String name, java.lang.Object value)
          Visits a primitive value of the annotation.
 AnnotationVisitor visitAnnotation(java.lang.String name, java.lang.String desc)
          Visits a nested annotation value of the annotation.
 AnnotationVisitor visitArray(java.lang.String name)
          Visits an array value of the annotation.
 void visitEnd()
          Visits the end of the annotation.
 void visitEnum(java.lang.String name, java.lang.String desc, java.lang.String value)
          Visits an enumeration value of the annotation.
 

Method Detail

visit

void visit(java.lang.String name,
           java.lang.Object value)
Visits a primitive value of the annotation.

Parameters:
name - the value name.
value - the actual value, whose type must be Byte, Boolean, Character, Short, Integer, Long, Float, Double, String or Type. This value can also be an array of byte, boolean, short, char, int, long, float or double values (this is equivalent to using visitArray and visiting each array element in turn, but is more convenient).

visitEnum

void visitEnum(java.lang.String name,
               java.lang.String desc,
               java.lang.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

AnnotationVisitor visitAnnotation(java.lang.String name,
                                  java.lang.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

AnnotationVisitor visitArray(java.lang.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 to visit. This is what ClassReader 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

void visitEnd()
Visits the end of the annotation.