Class RuntimeVisibleTypeAnnotations

java.lang.Object

org.apache.bcel.classfile.Attribute

org.apache.bcel.classfile.TypeAnnotations

org.apache.bcel.classfile.RuntimeVisibleTypeAnnotations

All Implemented Interfaces:

Cloneable, Iterable<TypeAnnotationEntry>, Node

public class RuntimeVisibleTypeAnnotations
extends TypeAnnotations

The type annotations of a class, field, method, record component or Code attribute, provided to the JVM and visible at runtime.

Since:

6.14.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
RuntimeVisibleTypeAnnotations(int nameIndex, int length, DataInput input, ConstantPool constantPool)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
Attribute	copy(ConstantPool constantPool)	Creates a deep copy of this attribute, whose type annotations are independent of this one's and refer to the given constant pool.
final void	dump(DataOutputStream dos)	Dumps attribute to file stream in binary format.

Methods inherited from class TypeAnnotations

accept, copyTypeAnnotations, getNumTypeAnnotations, getTypeAnnotationEntries, isRuntimeVisible, iterator, setTypeAnnotationTable, toString, writeTypeAnnotations

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.
protected final TypeAnnotationEntry[]	copyTypeAnnotations(ConstantPool constantPool)	Creates deep copies of the type annotations, which refer to the given constant pool.
final int	getNumTypeAnnotations()	Gets the number of type annotations.
TypeAnnotationEntry[]	getTypeAnnotationEntries()	Gets the type annotations.
boolean	isRuntimeVisible()	Tests whether the annotations are visible at runtime.
Iterator<TypeAnnotationEntry>	iterator()
final void	setTypeAnnotationTable(TypeAnnotationEntry[] typeAnnotationTable)	Sets the type annotations.
final String	toString()	Converts to a String representation.
protected void	writeTypeAnnotations(DataOutputStream dos)	Writes the type annotations to a DataOutputStream.

Methods inherited from class Attribute

addAttributeReader, addAttributeReader, clone, 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.
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

RuntimeVisibleTypeAnnotations

public RuntimeVisibleTypeAnnotations(int nameIndex,
 int length,
 DataInput input,
 ConstantPool constantPool)
                              throws IOException

Constructs a new instance.

Parameters:

nameIndex - Index pointing to the name of the attribute.

length - Content length in bytes.

input - Input stream.

constantPool - Array of constants.

Throws:

IOException - Thrown when an I/O exception of some sort has occurred.

Method Details

copy

public Attribute copy(ConstantPool constantPool)

Creates a deep copy of this attribute, whose type annotations are independent of this one's and refer to the given constant pool.

Specified by:

copy in class Attribute

Parameters:

constantPool - The constant pool of the copy.

Returns:

deep copy of this attribute.

dump

public final void dump(DataOutputStream dos)
                throws IOException

Description copied from class: Attribute

Dumps attribute to file stream in binary format.

Overrides:

dump in class Attribute

Parameters:

dos - Output file stream.

Throws:

IOException - Thrown if an I/O error occurs.