org.springframework.asm

Class AnnotationWriter

java.lang.Object

org.springframework.asm.AnnotationVisitor

org.springframework.asm.AnnotationWriter

final class AnnotationWriter
extends AnnotationVisitor

An AnnotationVisitor that generates annotations in bytecode form.

Author:

Eric Bruneton, Eugene Kuleshov

Field Summary

Fields

Modifier and Type	Field and Description
private ByteVector	bv The annotation values in bytecode form.
private ClassWriter	cw The class writer to which this annotation must be added.
private boolean	named true if values are named, false otherwise.
(package private) AnnotationWriter	next Next annotation writer.
private int	offset Where the number of values of this annotation must be stored in parent.
private ByteVector	parent The byte vector to be used to store the number of values of this annotation.
(package private) AnnotationWriter	prev Previous annotation writer.
private int	size The number of values in this annotation.

Fields inherited from class org.springframework.asm.AnnotationVisitor

api, av

Constructor Summary

Constructors

Constructor and Description
AnnotationWriter(ClassWriter cw, boolean named, ByteVector bv, ByteVector parent, int offset) Constructs a new AnnotationWriter.

Method Summary

Modifier and Type	Method and Description
(package private) int	getSize() Returns the size of this annotation writer list.
(package private) static void	put(AnnotationWriter[] panns, int off, ByteVector out) Puts the given annotation lists into the given byte vector.
(package private) void	put(ByteVector out) Puts the annotations of this annotation writer list into the given byte vector.
(package private) static void	putTarget(int typeRef, TypePath typePath, ByteVector out) Puts the given type reference and type path into the given bytevector.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cw

private final ClassWriter cw

The class writer to which this annotation must be added.

size

private int size

The number of values in this annotation.

named

private final boolean named

true if values are named, false otherwise. Annotation writers used for annotation default and annotation arrays use unnamed values.

bv

private final ByteVector bv

The annotation values in bytecode form. This byte vector only contains the values themselves, i.e. the number of values must be stored as a unsigned short just before these bytes.

parent

private final ByteVector parent

The byte vector to be used to store the number of values of this annotation. See bv.

offset

private final int offset

Where the number of values of this annotation must be stored in parent.

next

AnnotationWriter next

Next annotation writer. This field is used to store annotation lists.

prev

AnnotationWriter prev

Previous annotation writer. This field is used to store annotation lists.

Constructor Detail

AnnotationWriter

AnnotationWriter(ClassWriter cw,
                 boolean named,
                 ByteVector bv,
                 ByteVector parent,
                 int offset)

Constructs a new AnnotationWriter.

Parameters:

cw - the class writer to which this annotation must be added.

named - true if values are named, false otherwise.

bv - where the annotation values must be stored.

parent - where the number of annotation values must be stored.

offset - where in parent the number of annotation values must be stored.

Method Detail

visit

public void visit(java.lang.String name,
                  java.lang.Object value)

Description copied from class: AnnotationVisitor

Visits a primitive value of the annotation.

Overrides:

visit in class AnnotationVisitor

Parameters:

name - the value name.

value - the actual value, whose type must be Byte, Boolean, Character, Short, Integer , Long, Float, Double, String or Type or 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 using visitArray and visiting each array element in turn, but is more convenient).

visitEnum

public void visitEnum(java.lang.String name,
                      java.lang.String desc,
                      java.lang.String value)

Description copied from class: AnnotationVisitor

Visits an enumeration value of the annotation.

Overrides:

visitEnum in class AnnotationVisitor

Parameters:

name - the value name.

desc - the class descriptor of the enumeration class.

value - the actual enumeration value.

visitAnnotation

public AnnotationVisitor visitAnnotation(java.lang.String name,
                                         java.lang.String desc)

Description copied from class: AnnotationVisitor

Visits a nested annotation value of the annotation.

Overrides:

visitAnnotation in class AnnotationVisitor

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(java.lang.String name)

Description copied from class: AnnotationVisitor

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.

Overrides:

visitArray in class AnnotationVisitor

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()

Description copied from class: AnnotationVisitor

Visits the end of the annotation.

Overrides:

visitEnd in class AnnotationVisitor

getSize

int getSize()

Returns the size of this annotation writer list.

Returns:

the size of this annotation writer list.

put

void put(ByteVector out)

Puts the annotations of this annotation writer list into the given byte vector.

Parameters:

out - where the annotations must be put.

put

static void put(AnnotationWriter[] panns,
                int off,
                ByteVector out)

Puts the given annotation lists into the given byte vector.

Parameters:

panns - an array of annotation writer lists.

off - index of the first annotation to be written.

out - where the annotations must be put.

putTarget

static void putTarget(int typeRef,
                      TypePath typePath,
                      ByteVector out)

Puts the given type reference and type path into the given bytevector. LOCAL_VARIABLE and RESOURCE_VARIABLE target types are not supported.

Parameters:

typeRef - a reference to the annotated type. See TypeReference.

typePath - the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.

out - where the type reference and type path must be put.