Class LocalVariableTable

java.lang.Object

org.apache.bcel.classfile.Attribute

org.apache.bcel.classfile.LocalVariableTable

All Implemented Interfaces:

Cloneable, Iterable<LocalVariable>, Node

public class LocalVariableTable
extends Attribute
implements Iterable<LocalVariable>

This class represents a collection of local variables in a method. This attribute is contained in the Code attribute.

See Also:

• Code
• LocalVariable

Field Summary

Fields inherited from class Attribute

constant_pool, 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.
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
LocalVariableTable(int nameIndex, int length, LocalVariable[] localVariableTable, ConstantPool constantPool)	Constructs a new LocalVariableTable.
LocalVariableTable(LocalVariableTable c)	Initialize from another object.

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.
final void	dump(DataOutputStream file)	Dumps local variable table attribute to file stream in binary format.
final LocalVariable	getLocalVariable(int index)	Deprecated. Since 5.2 because multiple variables can share the same slot, use getLocalVariable(int index, int pc) instead.
final LocalVariable	getLocalVariable(int index, int pc)	Gets the local variable for the given index and program counter.
final LocalVariable[]	getLocalVariableTable()	Gets the local variable table.
final int	getTableLength()	Gets the table length.
Iterator<LocalVariable>	iterator()
final void	setLocalVariableTable(LocalVariable[] localVariableTable)	Sets the local variable table.
final String	toString()

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

LocalVariableTable

public LocalVariableTable(int nameIndex,
 int length,
 LocalVariable[] localVariableTable,
 ConstantPool constantPool)

Constructs a new LocalVariableTable.

Parameters:

nameIndex - Index in constant pool to 'LocalVariableTable'.

length - Content length in bytes.

localVariableTable - Table of local variables.

constantPool - Array of constants.

LocalVariableTable

public LocalVariableTable(LocalVariableTable c)

Initialize from another object. Note that both objects use the same references (shallow copy). Use copy() for a physical copy.

Parameters:

c - Source to copy.

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.

dump

public final void dump(DataOutputStream file)
                throws IOException

Dumps local variable table attribute to file stream in binary format.

Overrides:

dump in class Attribute

Parameters:

file - Output file stream.

Throws:

IOException - Thrown if an I/O error occurs.

getLocalVariable

@Deprecated
public final LocalVariable getLocalVariable(int index)

Deprecated.

Since 5.2 because multiple variables can share the same slot, use getLocalVariable(int index, int pc) instead.

Gets the local variable for the given index.

Parameters:

index - The variable slot.

Returns:

The first LocalVariable that matches the slot or null if not found.

getLocalVariable

public final LocalVariable getLocalVariable(int index,
 int pc)

Gets the local variable for the given index and program counter.

Parameters:

index - The variable slot.

pc - The current pc that this variable is alive.

Returns:

The LocalVariable that matches or null if not found.

getLocalVariableTable

public final LocalVariable[] getLocalVariableTable()

Gets the local variable table.

Returns:

Array of local variables of method.

getTableLength

public final int getTableLength()

Gets the table length.

Returns:

The table length.

iterator

public Iterator<LocalVariable> iterator()

Specified by:

iterator in interface Iterable<LocalVariable>

setLocalVariableTable

public final void setLocalVariableTable(LocalVariable[] localVariableTable)

Sets the local variable table.

Parameters:

localVariableTable - The local variable table to set.

toString

public final String toString()

Overrides:

toString in class Attribute

Returns:

String representation.