Class INVOKEINTERFACE

java.lang.Object

org.apache.bcel.generic.Instruction

org.apache.bcel.generic.CPInstruction

org.apache.bcel.generic.FieldOrMethod

org.apache.bcel.generic.InvokeInstruction

org.apache.bcel.generic.INVOKEINTERFACE

All Implemented Interfaces:

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

public final class INVOKEINTERFACE
extends InvokeInstruction

INVOKEINTERFACE - Invoke interface method

Stack: ..., objectref, [arg1, [arg2 ...]] -> ...

See Also:

• The invokeinterface instruction in The Java Virtual Machine Specification

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

Constructor	Description
INVOKEINTERFACE(int index, int nargs)	Constructs an INVOKEINTERFACE instruction.

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor v)	Call corresponding visitor method(s).
int	consumeStack(ConstantPoolGen cpg)	Also works for instructions whose stack effect depends on the constant pool entry they reference.
void	dump(DataOutputStream out)	Dumps instruction as byte code to stream out.
int	getCount()	Gets the count argument according to the Java Language Specification, Second Edition.
Class<?>[]	getExceptions()	Gets the exceptions that may be thrown by this instruction.
protected void	initFromFile(ByteSequence bytes, boolean wide)	Reads needed data (that is, index) from file.
String	toString(ConstantPool cp)	Gets the mnemonic for instruction with symbolic references resolved.

Methods inherited from class InvokeInstruction

getArgumentTypes, getClassName, getMethodName, getReturnType, getType, produceStack

Modifier and Type	Method	Description
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.

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

getIndex, setIndex, toString

Modifier and Type	Method	Description
final int	getIndex()	Gets the constant pool index referred to by this instruction.
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

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

Modifier and Type	Method	Description
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

Constructor Details

INVOKEINTERFACE

public INVOKEINTERFACE(int index,
 int nargs)

Constructs an INVOKEINTERFACE instruction.

Parameters:

index - index into constant pool.

nargs - number of arguments.

Method Details

accept

public void accept(Visitor v)

Call corresponding visitor method(s). The order is: Call visitor methods of implemented interfaces first, then call methods according to the class hierarchy in descending order, that is, the most specific visitXXX() call comes last.

Specified by:

accept in class Instruction

Parameters:

v - Visitor object.

consumeStack

public int consumeStack(ConstantPoolGen cpg)

Description copied from class: InvokeInstruction

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 InvokeInstruction

Parameters:

cpg - The constant pool generator.

Returns:

Number of words consumed from stack by this instruction.

dump

public void dump(DataOutputStream out)
          throws IOException

Dumps instruction as byte code to stream out.

Overrides:

dump in class CPInstruction

Parameters:

out - Output stream.

Throws:

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

getCount

public int getCount()

Gets the count argument according to the Java Language Specification, Second Edition.

Returns:

The count argument.

getExceptions

public Class<?>[] getExceptions()

Description copied from interface: ExceptionThrower

Gets the exceptions that may be thrown by this instruction.

Returns:

The exceptions that may be thrown by this instruction.

initFromFile

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

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

Overrides:

initFromFile in class CPInstruction

Parameters:

bytes - input stream.

wide - wide prefix?.

Throws:

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

toString

public String toString(ConstantPool cp)

Description copied from class: Instruction

Gets the mnemonic for instruction with symbolic references resolved.

Overrides:

toString in class InvokeInstruction

Parameters:

cp - The constant pool.

Returns:

mnemonic for instruction with symbolic references resolved.