Class ReturnInstruction

java.lang.Object

org.apache.bcel.generic.Instruction

org.apache.bcel.generic.ReturnInstruction

All Implemented Interfaces:

Cloneable, ExceptionThrower, StackConsumer, TypedInstruction

Direct Known Subclasses:

ARETURN, DRETURN, FRETURN, IRETURN, LRETURN, RETURN

public abstract class ReturnInstruction
extends Instruction
implements ExceptionThrower, TypedInstruction, StackConsumer

Superclass for the xRETURN family of instructions.

Field Summary

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	ReturnInstruction(short opcode)	Constructs a ReturnInstruction.

Method Summary

Modifier and Type	Method	Description
Class<?>[]	getExceptions()	Gets the exceptions that may be thrown by this instruction.
Type	getType()	Gets the type of the returned value.
Type	getType(ConstantPoolGen cp)	Gets the type associated with the instruction.

Methods inherited from class Instruction

accept, consumeStack, copy, dump, equals, getComparator, getLength, getName, getOpcode, hashCode, initFromFile, isValidByte, isValidShort, produceStack, readInstruction, setComparator, toString, toString, 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).
void	dump(DataOutputStream out)	Dumps instruction as byte code to stream out.
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.
protected void	initFromFile(ByteSequence bytes, boolean wide)	Reads needed data (for example index) from file.
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()
String	toString(boolean verbose)	Long output format: <name of opcode> "["<opcode number>"]" "("<length of instruction>")"
String	toString(ConstantPool cp)	Gets the mnemonic for instruction with symbolic references resolved.

Methods inherited from class Object

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

Methods inherited from interface StackConsumer

consumeStack

Modifier and Type	Method	Description
int	consumeStack(ConstantPoolGen cpg)	Gets how many words are consumed from stack.

Constructor Details

ReturnInstruction

protected ReturnInstruction(short opcode)

Constructs a ReturnInstruction.

Parameters:

opcode - of instruction.

Method Details

getExceptions

public Class<?>[] getExceptions()

Description copied from interface: ExceptionThrower

Gets the exceptions that may be thrown by this instruction.

Specified by:

getExceptions in interface ExceptionThrower

Returns:

The exceptions that may be thrown by this instruction.

getType

public Type getType()

Gets the type of the returned value.

Returns:

The type.

getType

public Type getType(ConstantPoolGen cp)

Gets the type associated with the instruction.

Specified by:

getType in interface TypedInstruction

Parameters:

cp - The constant pool generator.

Returns:

type associated with the instruction.