org.compass.core.util.asm
Class AnnotationWriter

java.lang.Object
  extended by org.compass.core.util.asm.AnnotationWriter
All Implemented Interfaces:
AnnotationVisitor

final class AnnotationWriter
extends Object
implements AnnotationVisitor

An AnnotationVisitor that generates annotations in bytecode form.

Author:
Eric Bruneton, Eugene Kuleshov

Field Summary
(package private)  AnnotationWriter next
          Next annotation writer.
(package private)  AnnotationWriter prev
          Previous annotation writer.
 
Constructor Summary
AnnotationWriter(ClassWriter cw, boolean named, ByteVector bv, ByteVector parent, int offset)
          Constructs a new AnnotationWriter.
 
Method Summary
(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.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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(String name,
                  Object value)
Description copied from interface: AnnotationVisitor
Visits a primitive value of the annotation.

Specified by:
visit in interface 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. 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(String name,
                      String desc,
                      String value)
Description copied from interface: AnnotationVisitor
Visits an enumeration value of the annotation.

Specified by:
visitEnum in interface AnnotationVisitor
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)
Description copied from interface: AnnotationVisitor
Visits a nested annotation value of the annotation.

Specified by:
visitAnnotation in interface 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(String name)
Description copied from interface: 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.

Specified by:
visitArray in interface 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 interface: AnnotationVisitor
Visits the end of the annotation.

Specified by:
visitEnd in interface 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.


Copyright (c) 2004-2008 The Compass Project.