Package org.objectweb.asm.tree
Class AnnotationNode
- java.lang.Object
-
- org.objectweb.asm.AnnotationVisitor
-
- org.objectweb.asm.tree.AnnotationNode
-
- Direct Known Subclasses:
TypeAnnotationNode
public class AnnotationNode extends AnnotationVisitor
A node that represents an annotation.
-
-
Field Summary
Fields Modifier and Type Field Description java.lang.String
desc
The class descriptor of the annotation class.java.util.List<java.lang.Object>
values
The name value pairs of this annotation.-
Fields inherited from class org.objectweb.asm.AnnotationVisitor
api, av
-
-
Constructor Summary
Constructors Constructor Description AnnotationNode(int api, java.lang.String descriptor)
Constructs a newAnnotationNode
.AnnotationNode(java.lang.String descriptor)
Constructs a newAnnotationNode
.AnnotationNode(java.util.List<java.lang.Object> values)
Constructs a newAnnotationNode
to visit an array value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(AnnotationVisitor annotationVisitor)
Makes the given visitor visit this annotation.(package private) static void
accept(AnnotationVisitor annotationVisitor, java.lang.String name, java.lang.Object value)
Makes the given visitor visit a given annotation value.void
check(int api)
Checks that this annotation node is compatible with the given ASM API version.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 descriptor)
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 descriptor, java.lang.String value)
Visits an enumeration value of the annotation.
-
-
-
Field Detail
-
desc
public java.lang.String desc
The class descriptor of the annotation class.
-
values
public java.util.List<java.lang.Object> values
The name value pairs of this annotation. Each name value pair is stored as two consecutive elements in the list. The name is aString
, and the value may be aByte
,Boolean
,Character
,Short
,Integer
,Long
,Float
,Double
,String
orType
, or a two elements String array (for enumeration values), anAnnotationNode
, or aList
of values of one of the preceding types. The list may be null if there is no name value pair.
-
-
Constructor Detail
-
AnnotationNode
public AnnotationNode(java.lang.String descriptor)
Constructs a newAnnotationNode
. Subclasses must not use this constructor. Instead, they must use theAnnotationNode(int, String)
version.- Parameters:
descriptor
- the class descriptor of the annotation class.- Throws:
java.lang.IllegalStateException
- If a subclass calls this constructor.
-
AnnotationNode
public AnnotationNode(int api, java.lang.String descriptor)
Constructs a newAnnotationNode
.- Parameters:
api
- the ASM API version implemented by this visitor. Must be one of theASM
x values inOpcodes
.descriptor
- the class descriptor of the annotation class.
-
AnnotationNode
AnnotationNode(java.util.List<java.lang.Object> values)
Constructs a newAnnotationNode
to visit an array value.- Parameters:
values
- where the visited 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 classAnnotationVisitor
- Parameters:
name
- the value name.value
- the actual value, whose type must beByte
,Boolean
,Character
,Short
,Integer
,Long
,Float
,Double
,String
orType
ofType.OBJECT
orType.ARRAY
sort. This value can also be an array of byte, boolean, short, char, int, long, float or double values (this is equivalent to usingAnnotationVisitor.visitArray(java.lang.String)
and visiting each array element in turn, but is more convenient).
-
visitEnum
public void visitEnum(java.lang.String name, java.lang.String descriptor, java.lang.String value)
Description copied from class:AnnotationVisitor
Visits an enumeration value of the annotation.- Overrides:
visitEnum
in classAnnotationVisitor
- Parameters:
name
- the value name.descriptor
- the class descriptor of the enumeration class.value
- the actual enumeration value.
-
visitAnnotation
public AnnotationVisitor visitAnnotation(java.lang.String name, java.lang.String descriptor)
Description copied from class:AnnotationVisitor
Visits a nested annotation value of the annotation.- Overrides:
visitAnnotation
in classAnnotationVisitor
- 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(java.lang.String name)
Description copied from class:AnnotationVisitor
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 tovisit
. This is whatClassReader
does for non empty arrays of primitive values.- Overrides:
visitArray
in classAnnotationVisitor
- 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 classAnnotationVisitor
-
check
public void check(int api)
Checks that this annotation node is compatible with the given ASM API version. This method checks that this node, and all its children recursively, do not contain elements that were introduced in more recent versions of the ASM API than the given version.- Parameters:
api
- an ASM API version. Must be one of theASM
x values inOpcodes
.
-
accept
public void accept(AnnotationVisitor annotationVisitor)
Makes the given visitor visit this annotation.- Parameters:
annotationVisitor
- an annotation visitor. Maybe null.
-
accept
static void accept(AnnotationVisitor annotationVisitor, java.lang.String name, java.lang.Object value)
Makes the given visitor visit a given annotation value.- Parameters:
annotationVisitor
- an annotation visitor. Maybe null.name
- the value name.value
- the actual value.
-
-