Class Annotations

java.lang.Object

org.apache.bcel.classfile.Attribute

org.apache.bcel.classfile.Annotations

All Implemented Interfaces:

Cloneable, Iterable<AnnotationEntry>, Node

Direct Known Subclasses:

RuntimeInvisibleAnnotations, RuntimeVisibleAnnotations

public abstract class Annotations
extends Attribute
implements Iterable<AnnotationEntry>

base class for annotations

Since:

6.0

Field Summary

Fields inherited from class Attribute

constant_pool, EMPTY_ARRAY, length, name_index, tag

Modifier and Type	Field	Description
protected ConstantPool	constant_pool	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter.
static final Attribute[]	EMPTY_ARRAY	Empty array.
protected int	length	Deprecated. (since 6.0) (since 6.0) will be made private; do not access directly, use getter/setter.
protected int	name_index	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter.
protected byte	tag	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter.

Constructor Summary

Constructors

Constructor	Description
Annotations(byte annotationType, int nameIndex, int length, AnnotationEntry[] annotationTable, ConstantPool constantPool, boolean isRuntimeVisible)	Constructs an instance.

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor v)	Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class.
Attribute	copy(ConstantPool constantPool)	Creates a deep copy of this attribute.
AnnotationEntry[]	getAnnotationEntries()	Gets the array of annotation entries in this annotation.
final int	getNumAnnotations()	Gets the number of annotation entries in this annotation.
boolean	isRuntimeVisible()	Tests whether this annotation is runtime visible.
Iterator<AnnotationEntry>	iterator()
final void	setAnnotationTable(AnnotationEntry[] annotationTable)	Sets the entries to set in this annotation.
final String	toString()	Converts to a String representation.
protected void	writeAnnotations(DataOutputStream dos)	Writes the annotations to a DataOutputStream.

Methods inherited from class Attribute

addAttributeReader, addAttributeReader, clone, dump, getConstantPool, getLength, getName, getNameIndex, getTag, println, readAttribute, readAttribute, readAttribute, removeAttributeReader, setConstantPool, setLength, setNameIndex

Modifier and Type	Method	Description
static void	addAttributeReader(String name, AttributeReader attributeReader)	Deprecated. (6.0) Use Attribute.addAttributeReader(String, UnknownAttributeReader) instead.
static void	addAttributeReader(String name, UnknownAttributeReader unknownAttributeReader)	Add an Attribute reader capable of parsing (user-defined) attributes named "name".
Object	clone()	Use copy() if you want to have a deep copy(), that is, with all references copied correctly.
void	dump(DataOutputStream file)	Dumps attribute to file stream in binary format.
final ConstantPool	getConstantPool()	Gets the constant pool used by this object.
final int	getLength()	Gets the length of attribute field in bytes.
String	getName()	Gets the name of the attribute.
final int	getNameIndex()	Gets the name index in constant pool of attribute name.
final byte	getTag()	Gets the tag of attribute, that is, its type.
protected static void	println(String msg)	Prints a message to stderr if debug mode is enabled.
static Attribute	readAttribute(DataInput dataInput, ConstantPool constantPool)	Reads one attribute using standard eight-byte Code headers.
static Attribute	readAttribute(DataInput dataInput, ConstantPool constantPool, boolean compactCodeHeader)	Reads one attribute using the selected Code header layout.
static Attribute	readAttribute(DataInputStream dataInputStream, ConstantPool constantPool)	Reads one attribute using standard eight-byte Code headers.
static void	removeAttributeReader(String name)	Remove attribute reader
final void	setConstantPool(ConstantPool constantPool)	Sets the constant pool to be used for this object.
final void	setLength(int length)	Sets the length in bytes.
final void	setNameIndex(int nameIndex)	Sets the name index of attribute.

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

Annotations

public Annotations(byte annotationType,
 int nameIndex,
 int length,
 AnnotationEntry[] annotationTable,
 ConstantPool constantPool,
 boolean isRuntimeVisible)

Constructs an instance.

Parameters:

annotationType - The subclass type of the annotation.

nameIndex - Index pointing to the name Code.

length - Content length in bytes.

annotationTable - The actual annotations.

constantPool - Array of constants.

isRuntimeVisible - whether this Annotation visible at runtime.

Method Details

accept

public void accept(Visitor v)

Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class. That is, the hierarchy of methods, fields, attributes, and other elements forms a tree of objects.

Specified by:

accept in interface Node

Specified by:

accept in class Attribute

Parameters:

v - Visitor object.

copy

public Attribute copy(ConstantPool constantPool)

Description copied from class: Attribute

Creates a deep copy of this attribute.

Specified by:

copy in class Attribute

Parameters:

constantPool - constant pool to save.

Returns:

deep copy of this attribute.

getAnnotationEntries

public AnnotationEntry[] getAnnotationEntries()

Gets the array of annotation entries in this annotation.

Returns:

The array of annotation entries in this annotation.

getNumAnnotations

public final int getNumAnnotations()

Gets the number of annotation entries in this annotation.

Returns:

The number of annotation entries in this annotation.

isRuntimeVisible

public boolean isRuntimeVisible()

Tests whether this annotation is runtime visible.

Returns:

true if this annotation is runtime visible.

iterator

public Iterator<AnnotationEntry> iterator()

Specified by:

iterator in interface Iterable<AnnotationEntry>

setAnnotationTable

public final void setAnnotationTable(AnnotationEntry[] annotationTable)

Sets the entries to set in this annotation.

Parameters:

annotationTable - The entries to set in this annotation.

toString

public final String toString()

Converts to a String representation.

Overrides:

toString in class Attribute

Returns:

String representation.

writeAnnotations

protected void writeAnnotations(DataOutputStream dos)
                         throws IOException

Writes the annotations to a DataOutputStream.

Parameters:

dos - The data output stream.

Throws:

IOException - Thrown if an I/O error occurs.