Class InvokeInstruction

java.lang.Object

org.apache.bcel.generic.Instruction

org.apache.bcel.generic.CPInstruction

org.apache.bcel.generic.FieldOrMethod

org.apache.bcel.generic.InvokeInstruction

All Implemented Interfaces:

Cloneable, ExceptionThrower, IndexedInstruction, LoadClass, StackConsumer, StackProducer, TypedInstruction

Direct Known Subclasses:

INVOKEDYNAMIC, INVOKEINTERFACE, INVOKESPECIAL, INVOKESTATIC, INVOKEVIRTUAL

public abstract class InvokeInstruction
extends FieldOrMethod
implements ExceptionThrower, StackConsumer, StackProducer

Superclass for the INVOKExxx family of instructions.

Field Summary

Fields inherited from class CPInstruction

index

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	InvokeInstruction(short opcode, int index)	Constructs an InvokeInstruction.

Method Summary

Modifier and Type	Method	Description
int	consumeStack(ConstantPoolGen cpg)	Also works for instructions whose stack effect depends on the constant pool entry they reference.
Type[]	getArgumentTypes(ConstantPoolGen cpg)	Gets the argument types of referenced method.
String	getClassName(ConstantPoolGen cpg)	Gets the name of the referenced class or interface.
String	getMethodName(ConstantPoolGen cpg)	Gets the name of referenced method.
Type	getReturnType(ConstantPoolGen cpg)	Gets the return type of referenced method.
Type	getType(ConstantPoolGen cpg)	Gets the return type of referenced method.
int	produceStack(ConstantPoolGen cpg)	Also works for instructions whose stack effect depends on the constant pool entry they reference.
String	toString(ConstantPool cp)	Gets the mnemonic for instruction with symbolic references resolved.

Methods inherited from class FieldOrMethod

getClassType, getLoadClassType, getName, getReferenceType, getSignature

Modifier and Type	Method	Description
ObjectType	getClassType(ConstantPoolGen cpg)	Deprecated. If the instruction references an array class, the ObjectType returned will be invalid.
ObjectType	getLoadClassType(ConstantPoolGen cpg)	Gets the ObjectType of the method return or field.
String	getName(ConstantPoolGen cpg)	Gets the name of referenced method or field.
ReferenceType	getReferenceType(ConstantPoolGen cpg)	Gets the reference type representing the class, interface, or array class referenced by the instruction.
String	getSignature(ConstantPoolGen cpg)	Gets the signature of referenced method or field.

Methods inherited from class CPInstruction

dump, getIndex, initFromFile, setIndex, toString

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.
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>">"

Methods inherited from class Instruction

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

Modifier and Type	Method	Description
abstract void	accept(Visitor v)	Call corresponding visitor method(s).
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).
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

Methods inherited from interface ExceptionThrower

getExceptions

Modifier and Type	Method	Description
Class<?>[]	getExceptions()	Gets the exceptions that may be thrown by this instruction.

Constructor Details

InvokeInstruction

protected InvokeInstruction(short opcode,
 int index)

Constructs an InvokeInstruction.

Parameters:

opcode - The opcode.

index - to constant pool.

Method Details

consumeStack

public int consumeStack(ConstantPoolGen cpg)

Also works for instructions whose stack effect depends on the constant pool entry they reference.

Specified by:

consumeStack in interface StackConsumer

Overrides:

consumeStack in class Instruction

Parameters:

cpg - The constant pool generator.

Returns:

Number of words consumed from stack by this instruction.

getArgumentTypes

public Type[] getArgumentTypes(ConstantPoolGen cpg)

Gets the argument types of referenced method.

Parameters:

cpg - The constant pool generator.

Returns:

argument types of referenced method.

getClassName

public String getClassName(ConstantPoolGen cpg)

Gets the name of the referenced class or interface.

This overrides the deprecated version as we know here that the referenced class may legally be an array.

Overrides:

getClassName in class FieldOrMethod

Parameters:

cpg - The constant pool generator.

Returns:

name of the referenced class/interface.

Throws:

IllegalArgumentException - Thrown if the referenced class is an array (this should not happen)

getMethodName

public String getMethodName(ConstantPoolGen cpg)

Gets the name of referenced method.

Parameters:

cpg - The constant pool generator.

Returns:

name of referenced method.

getReturnType

public Type getReturnType(ConstantPoolGen cpg)

Gets the return type of referenced method.

Parameters:

cpg - The constant pool generator.

Returns:

return type of referenced method.

getType

public Type getType(ConstantPoolGen cpg)

Gets the return type of referenced method.

Specified by:

getType in interface LoadClass

Specified by:

getType in interface TypedInstruction

Overrides:

getType in class CPInstruction

Parameters:

cpg - The constant pool generator.

Returns:

return type of referenced method.

See Also:

• LoadClass.getLoadClassType(ConstantPoolGen)

produceStack

public int produceStack(ConstantPoolGen cpg)

Also works for instructions whose stack effect depends on the constant pool entry they reference.

Specified by:

produceStack in interface StackProducer

Overrides:

produceStack in class Instruction

Parameters:

cpg - The constant pool generator.

Returns:

Number of words produced onto stack by this 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 CPInstruction

Parameters:

cp - The constant pool.

Returns:

mnemonic for instruction with symbolic references resolved.