Class TypeAnnotations

java.lang.Object

org.apache.bcel.classfile.Attribute

org.apache.bcel.classfile.TypeAnnotations

All Implemented Interfaces:

Cloneable, Iterable<TypeAnnotationEntry>, Node

Direct Known Subclasses:

RuntimeInvisibleTypeAnnotations, RuntimeVisibleTypeAnnotations

public abstract class TypeAnnotations
extends Attribute
implements Iterable<TypeAnnotationEntry>

Base class for the type annotation attributes, RuntimeVisibleTypeAnnotations and RuntimeInvisibleTypeAnnotations: the annotations written on the types used in a declaration (such as List<@Nullable String>, the supertypes of a class, a throws clause, or the declaration and the bounds of a type parameter as in <T extends @Nullable Object>) or in the code of a method (such as a cast, an instanceof, a new expression or a local variable), which the attributes of the declaration annotations do not hold. They are attributes of a class, a field, a method, a record component or a Code attribute.

Since:

6.14.0

See Also:

• JVMS 4.7.20 The RuntimeVisibleTypeAnnotations attribute

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
TypeAnnotations(byte annotationType, int nameIndex, int length, TypeAnnotationEntry[] typeAnnotationTable, 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.
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, copy, 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.
abstract Attribute	copy(ConstantPool constantPool)	Creates a deep copy of this attribute.
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

TypeAnnotations

public TypeAnnotations(byte annotationType,
 int nameIndex,
 int length,
 TypeAnnotationEntry[] typeAnnotationTable,
 ConstantPool constantPool,
 boolean isRuntimeVisible)

Constructs an instance.

Parameters:

annotationType - The subclass type of the attribute.

nameIndex - Index pointing to the name of the attribute.

length - Content length in bytes.

typeAnnotationTable - The actual type annotations.

constantPool - Array of constants.

isRuntimeVisible - whether the annotations are visible at runtime.

Method Details

accept

public void accept(Visitor v)

Description copied from class: Attribute

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.

copyTypeAnnotations

protected final TypeAnnotationEntry[] copyTypeAnnotations(ConstantPool constantPool)

Creates deep copies of the type annotations, which refer to the given constant pool.

Parameters:

constantPool - The constant pool of the copies.

Returns:

The copies.

getNumTypeAnnotations

public final int getNumTypeAnnotations()

Gets the number of type annotations.

Returns:

The number of type annotations.

getTypeAnnotationEntries

public TypeAnnotationEntry[] getTypeAnnotationEntries()

Gets the type annotations.

Returns:

The type annotations.

isRuntimeVisible

public boolean isRuntimeVisible()

Tests whether the annotations are visible at runtime.

Returns:

true if the annotations are runtime visible.

iterator

public Iterator<TypeAnnotationEntry> iterator()

Specified by:

iterator in interface Iterable<TypeAnnotationEntry>

setTypeAnnotationTable

public final void setTypeAnnotationTable(TypeAnnotationEntry[] typeAnnotationTable)

Sets the type annotations.

Parameters:

typeAnnotationTable - The type annotations.

toString

public final String toString()

Converts to a String representation.

Overrides:

toString in class Attribute

Returns:

String representation.

writeTypeAnnotations

protected void writeTypeAnnotations(DataOutputStream dos)
                             throws IOException

Writes the type annotations to a DataOutputStream.

Parameters:

dos - The data output stream.

Throws:

IOException - Thrown if an I/O error occurs.