Class LineNumberTable

java.lang.Object

org.apache.bcel.classfile.Attribute

org.apache.bcel.classfile.LineNumberTable

All Implemented Interfaces:

Cloneable, Iterable<LineNumber>, Node

public final class LineNumberTable
extends Attribute
implements Iterable<LineNumber>

This class represents a table of line numbers for debugging purposes. This attribute is used by the Code attribute. It contains pairs of PCs and line numbers.

See Also:

• Code
• LineNumber

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
LineNumberTable(int nameIndex, int length, LineNumber[] lineNumberTable, ConstantPool constantPool)	Constructs a new instance.
LineNumberTable(LineNumberTable c)	Constructs a new instance from another.

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.
void	dump(DataOutputStream file)	Dumps line number table attribute to file stream in binary format.
LineNumber[]	getLineNumberTable()	Gets the line number table.
int	getSourceLine(int pos)	Gets the source code line corresponding to a bytecode position.
int	getTableLength()	Gets the length of the line number table.
Iterator<LineNumber>	iterator()
void	setLineNumberTable(LineNumber[] lineNumberTable)	Sets the line number table.
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

LineNumberTable

public LineNumberTable(int nameIndex,
 int length,
 LineNumber[] lineNumberTable,
 ConstantPool constantPool)

Constructs a new instance.

Parameters:

nameIndex - Index of name.

length - Content length in bytes.

lineNumberTable - Table of line/numbers pairs.

constantPool - Array of constants.

LineNumberTable

public LineNumberTable(LineNumberTable c)

Constructs a new instance from another.

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

Parameters:

c - The instance 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 void dump(DataOutputStream file)
          throws IOException

Dumps line number 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 Exception occurs in writeShort.

getLineNumberTable

public LineNumber[] getLineNumberTable()

Gets the line number table.

Returns:

Array of (pc offset, line number) pairs.

getSourceLine

public int getSourceLine(int pos)

Gets the source code line corresponding to a bytecode position.

Parameters:

pos - byte code offset.

Returns:

corresponding line in source code.

getTableLength

public int getTableLength()

Gets the length of the line number table.

Returns:

The length of the line number table.

iterator

public Iterator<LineNumber> iterator()

Specified by:

iterator in interface Iterable<LineNumber>

setLineNumberTable

public void setLineNumberTable(LineNumber[] lineNumberTable)

Sets the line number table.

Parameters:

lineNumberTable - The line number entries for this table.

toString

public String toString()

Overrides:

toString in class Attribute

Returns:

String representation.