Package org.apache.bcel.generic

Class RET

java.lang.Object

org.apache.bcel.generic.Instruction

org.apache.bcel.generic.RET

All Implemented Interfaces:

java.lang.Cloneable, IndexedInstruction, TypedInstruction

public class RET
extends Instruction
implements IndexedInstruction, TypedInstruction

RET - Return from subroutine

 Stack: ... -> ...
 

Field Summary

Fields inherited from class org.apache.bcel.generic.Instruction

length, opcode

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(java.io.DataOutputStream out)	Dumps instruction as byte code to stream out.
int	getIndex()	Gets the index.
Type	getType(ConstantPoolGen cp)	Gets the type associated with this instruction.
protected void	initFromFile(ByteSequence bytes, boolean wide)	Reads needed data (for example index) from file.
void	setIndex(int index)	Sets index of local variable containg the return address
java.lang.String	toString(boolean verbose)	Long output format: <name of opcode> "["<opcode number>"]" "("<length of instruction>")"

Methods inherited from class org.apache.bcel.generic.Instruction

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RET

public RET(int index)

Constructs a RET instruction.

Parameters:

index - index of local variable containing the return address.

Method Detail

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(java.io.DataOutputStream out)
          throws java.io.IOException

Dumps instruction as byte code to stream out.

Overrides:

dump in class Instruction

Parameters:

out - Output stream.

Throws:

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

getIndex

public final int getIndex()

Description copied from interface: IndexedInstruction

Gets the index.

Specified by:

getIndex in interface IndexedInstruction

Returns:

index of local variable containg the return address.

getType

public Type getType(ConstantPoolGen cp)

Description copied from interface: TypedInstruction

Gets the type associated with this instruction.

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 java.io.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:

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

setIndex

public final void setIndex(int index)

Sets index of local variable containg the return address

Specified by:

setIndex in interface IndexedInstruction

Parameters:

index - index of local variable containg the return address.

Throws:

ClassGenException - Thrown if index is out of bounds.

toString

public java.lang.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.