Class RET

java.lang.Object

org.apache.bcel.generic.Instruction

org.apache.bcel.generic.RET

All Implemented Interfaces:

Cloneable, IndexedInstruction, TypedInstruction

public class RET
extends Instruction
implements IndexedInstruction, TypedInstruction

RET - Return from subroutine

Stack: ... -> ...

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

Constructor	Description
RET(int index)	Constructs a RET instruction.

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor v)	Call corresponding visitor method(s).
void	dump(DataOutputStream out)	Dumps instruction as byte code to stream out.
final int	getIndex()	Gets the index of the local variable containing the return address.
Type	getType(ConstantPoolGen cp)	Gets the return address type.
protected void	initFromFile(ByteSequence bytes, boolean wide)	Reads needed data (for example index) from file.
final void	setIndex(int index)	Sets the index of the local variable containing the return address.
String	toString(boolean verbose)	Long output format: <name of opcode> "["<opcode number>"]" "("<length of instruction>")"

Methods inherited from class Instruction

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

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

Constructor Details

RET

public RET(int index)

Constructs a RET instruction.

Parameters:

index - index of local variable containing the return address.

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.

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 index of the local variable containing the return address.

Specified by:

getIndex in interface IndexedInstruction

Returns:

index of local variable containing the return address.

getType

public Type getType(ConstantPoolGen cp)

Gets the return address type.

Specified by:

getType in interface TypedInstruction

Parameters:

cp - The constant pool generator.

Returns:

return address type.

initFromFile

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

Reads needed data (for example index) from file.

Overrides:

initFromFile in class Instruction

Parameters:

bytes - byte sequence to read from.

wide - "wide" instruction flag.

Throws:

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

setIndex

public final void setIndex(int index)

Sets the index of the local variable containing the return address.

Specified by:

setIndex in interface IndexedInstruction

Parameters:

index - index of local variable containing the return address.

Throws:

ClassGenException - Thrown if index is out of bounds.

toString

public String toString(boolean verbose)

Description copied from class: Instruction

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

Overrides:

toString in class Instruction

Parameters:

verbose - long/short format switch.

Returns:

mnemonic for instruction.