Class JsrInstruction

java.lang.Object

org.apache.bcel.generic.Instruction

org.apache.bcel.generic.BranchInstruction

org.apache.bcel.generic.JsrInstruction

All Implemented Interfaces:

Cloneable, InstructionTargeter, StackProducer, TypedInstruction, UnconditionalBranch

Direct Known Subclasses:

JSR, JSR_W

public abstract class JsrInstruction
extends BranchInstruction
implements UnconditionalBranch, TypedInstruction, StackProducer

Superclass for JSR - Jump to subroutine

Field Summary

Fields inherited from class BranchInstruction

index, position, target

Modifier and Type	Field	Description
protected int	index	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter
protected int	position	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter
protected InstructionHandle	target	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

Method Summary

Modifier and Type	Method	Description
Type	getType(ConstantPoolGen cp)	Gets the return address type.
InstructionHandle	physicalSuccessor()	Returns an InstructionHandle to the physical successor of this JsrInstruction.

Methods inherited from class BranchInstruction

containsTarget, dump, getIndex, getPosition, getTarget, getTargetOffset, getTargetOffset, initFromFile, setIndex, setPosition, setTarget, toString, updatePosition, updateTarget

Modifier and Type	Method	Description
boolean	containsTarget(InstructionHandle ih)	Tests whether this targeter targets the specified instruction handle.
void	dump(DataOutputStream out)	Dumps instruction as byte code to stream out.
final int	getIndex()	Gets the target offset in byte code.
protected int	getPosition()	Gets the position.
InstructionHandle	getTarget()	Gets the target of branch instruction.
protected int	getTargetOffset()	Gets the offset to this instruction's target.
protected int	getTargetOffset(InstructionHandle target)	Gets the offset to target relative to this instruction.
protected void	initFromFile(ByteSequence bytes, boolean wide)	Reads needed data (for example index) from file.
protected void	setIndex(int index)	Sets the index.
protected void	setPosition(int position)	Sets the position.
void	setTarget(InstructionHandle target)	Sets branch target.
String	toString(boolean verbose)	Long output format: <position in byte code> <name of opcode> "["<opcode number>"]" "("<length of instruction>")" "<"<target instruction>">" "@"<branch target offset>
protected int	updatePosition(int offset, int maxOffset)	Called by InstructionList.setPositions when setting the position for every instruction.
void	updateTarget(InstructionHandle oldIh, InstructionHandle newIh)	Replaces the target of this targeter from this old handle to the new handle.

Methods inherited from class Instruction

accept, consumeStack, copy, equals, getComparator, getLength, getName, getOpcode, hashCode, isValidByte, isValidShort, produceStack, readInstruction, setComparator, 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).
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

Methods inherited from interface StackProducer

produceStack

Modifier and Type	Method	Description
int	produceStack(ConstantPoolGen cpg)	Gets how many words are produced on stack.

Method Details

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.

physicalSuccessor

public InstructionHandle physicalSuccessor()

Returns an InstructionHandle to the physical successor of this JsrInstruction. For this method to work, this JsrInstruction object must not be shared between multiple InstructionHandle objects! Formally, there must not be InstructionHandle objects i, j where i != j and i.getInstruction() == this == j.getInstruction().

Returns:

An InstructionHandle to the "next" instruction that will be executed when RETurned from a subroutine.