Class CPInstruction

java.lang.Object

org.apache.bcel.generic.Instruction

org.apache.bcel.generic.CPInstruction

All Implemented Interfaces:

Cloneable, IndexedInstruction, TypedInstruction

Direct Known Subclasses:

ANEWARRAY, CHECKCAST, FieldOrMethod, INSTANCEOF, LDC, LDC2_W, MULTIANEWARRAY, NameSignatureInstruction, NEW

public abstract class CPInstruction
extends Instruction
implements TypedInstruction, IndexedInstruction

Abstract superclass for instructions that use an index into the constant pool such as LDC, INVOKEVIRTUAL, and so on.

See Also:

• ConstantPoolGen
• LDC
• INVOKEVIRTUAL

Field Summary

Fields

Modifier and Type	Field	Description
protected int	index	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter

Fields inherited from class Instruction

length, opcode

Modifier and Type	Field	Description
protected short	length	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter
protected short	opcode	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CPInstruction(short opcode, int index)	Constructs a CPInstruction.

Method Summary

Modifier and Type	Method	Description
void	dump(DataOutputStream out)	Dumps instruction as byte code to stream out.
final int	getIndex()	Gets the constant pool index referred to by this instruction.
Type	getType(ConstantPoolGen cpg)	Gets the type associated with this instruction.
protected void	initFromFile(ByteSequence bytes, boolean wide)	Reads needed data (that is, index) from file.
void	setIndex(int index)	Sets the index to constant pool.
String	toString(boolean verbose)	Long output format: <name of opcode> "["<opcode number>"]" "("<length of instruction>")" "<"< constant pool index>">"
String	toString(ConstantPool cp)	Gets the mnemonic for instruction with symbolic references resolved.

Methods inherited from class Instruction

accept, consumeStack, copy, equals, getComparator, getLength, getName, getOpcode, hashCode, isValidByte, isValidShort, produceStack, readInstruction, setComparator, toString

Modifier and Type	Method	Description
abstract void	accept(Visitor v)	Call corresponding visitor method(s).
int	consumeStack(ConstantPoolGen cpg)	This method also gives right results for instructions whose effect on the stack depends on the constant pool entry they reference.
Instruction	copy()	Use with caution, since 'BranchInstruction's have a 'target' reference which is not copied correctly (only basic types are).
boolean	equals(Object that)	Tests for equality, delegated to comparator
static InstructionComparator	getComparator()	Deprecated. (6.0) use the built in comparator, or wrap this class in another object that implements these methods
int	getLength()	Gets the length (in bytes) of instruction.
String	getName()	Gets the name of instruction, that is, opcode name.
short	getOpcode()	Gets this instruction's opcode.
int	hashCode()	Gets the hashCode of this object.
static boolean	isValidByte(int value)	Tests if the value can fit in a byte (signed).
static boolean	isValidShort(int value)	Tests if the value can fit in a short (signed).
int	produceStack(ConstantPoolGen cpg)	This method also gives right results for instructions whose effect on the stack depends on the constant pool entry they reference.
static Instruction	readInstruction(ByteSequence bytes)	Reads an instruction from (byte code) input stream and return the appropriate object.
static void	setComparator(InstructionComparator c)	Deprecated. (6.0) use the built in comparator, or wrap this class in another object that implements these methods
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

index

@Deprecated
protected int index

Deprecated.

(since 6.0) will be made private; do not access directly, use getter/setter

Constructor Details

CPInstruction

protected CPInstruction(short opcode,
 int index)

Constructs a CPInstruction.

Parameters:

opcode - The opcode.

index - to constant pool.

Method Details

dump

public void dump(DataOutputStream out)
          throws IOException

Dumps instruction as byte code to stream out.

Overrides:

dump in class Instruction

Parameters:

out - Output stream.

Throws:

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

getIndex

public final int getIndex()

Gets the constant pool index referred to by this instruction.

Specified by:

getIndex in interface IndexedInstruction

Returns:

index in constant pool referred by this instruction.

getType

public Type getType(ConstantPoolGen cpg)

Gets the type associated with this instruction.

Specified by:

getType in interface TypedInstruction

Parameters:

cpg - The constant pool generator.

Returns:

type related with this instruction.

initFromFile

protected void initFromFile(ByteSequence bytes,
 boolean wide)
                     throws IOException

Reads needed data (that is, index) from file.

Overrides:

initFromFile in class Instruction

Parameters:

bytes - input stream.

wide - wide prefix?.

Throws:

IOException - Thrown if the implementation needs to read data from the file

setIndex

public void setIndex(int index)

Sets the index to constant pool.

Specified by:

setIndex in interface IndexedInstruction

Parameters:

index - in constant pool.

Throws:

ClassGenException - Thrown if index is out of bounds.

toString

public String toString(boolean verbose)

Long output format: <name of opcode> "["<opcode number>"]" "("<length of instruction>")" "<"< constant pool index>">"

Overrides:

toString in class Instruction

Parameters:

verbose - long/short format switch.

Returns:

mnemonic for instruction.

toString

public String toString(ConstantPool cp)

Description copied from class: Instruction

Gets the mnemonic for instruction with symbolic references resolved.

Overrides:

toString in class Instruction

Parameters:

cp - The constant pool.

Returns:

mnemonic for instruction with symbolic references resolved.