public interface

AnnotationVisitor

org.sonatype.guice.bean.scanners.asm.AnnotationVisitor
Known Indirect Subclasses

Class Overview

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

Summary

Public Methods
abstract void visit(String name, Object value)
Visits a primitive value of the annotation.
abstract AnnotationVisitor visitAnnotation(String name, String desc)
Visits a nested annotation value of the annotation.
abstract AnnotationVisitor visitArray(String name)
Visits an array value of the annotation.
abstract void visitEnd()
Visits the end of the annotation.
abstract void visitEnum(String name, String desc, String value)
Visits an enumeration value of the annotation.

Public Methods

public abstract 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. 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).

public abstract 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.

public abstract 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 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.

public abstract void visitEnd ()

Visits the end of the annotation.

public abstract 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.