Package org.springframework.asm

Class AnnotationVisitor

java.lang.Object
org.springframework.asm.AnnotationVisitor
Direct Known Subclasses:
AnnotationVisitorTee
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 Details

    • api

      protected final int api
      The ASM API version implemented by this visitor. The value of this field must be one of the ASMx values in Opcodes.

    • av

      protected AnnotationVisitor av
      The annotation visitor to which this visitor must delegate method calls. May be null.

  • Constructor Details

    • AnnotationVisitor

      protected AnnotationVisitor(int api)
      Constructs a new AnnotationVisitor.
      Parameters:
      api - the ASM API version implemented by this visitor. Must be one of the ASMx values in Opcodes.

    • AnnotationVisitor

      protected AnnotationVisitor(int api, AnnotationVisitor annotationVisitor)
      Constructs a new AnnotationVisitor.
      Parameters:
      api - the ASM API version implemented by this visitor. Must be one of the ASMx values in Opcodes.
      annotationVisitor - the annotation visitor to which this visitor must delegate method calls. May be null.

  • Method Details

    • getDelegate

      public AnnotationVisitor getDelegate()
      The annotation visitor to which this visitor must delegate method calls. May be null.
      Returns:
      the annotation visitor to which this visitor must delegate method calls, or null.

    • 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 be Byte, Boolean, Character, Short, Integer , Long, Float, Double, String or Type of Type.OBJECT or Type.ARRAY sort. This value can also be an array of byte, boolean, short, char, int, long, float or double values (this is equivalent to using visitArray(java.lang.String) and visiting each array element in turn, but is more convenient).

    • visitEnum

      public void visitEnum(String name, String descriptor, String value)
      Visits an enumeration value of the annotation.
      Parameters:
      name - the value name.
      descriptor - the class descriptor of the enumeration class.
      value - the actual enumeration value.

    • visitAnnotation

      public AnnotationVisitor visitAnnotation(String name, String descriptor)
      Visits a nested annotation value of the annotation.
      Parameters:
      name - the value name.
      descriptor - 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 values (such as byte, boolean, short, char, int, long, float or double) can be passed as value to visit. This is what ClassReader does for non empty arrays of primitive values.
      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.