Class Select

java.lang.Object

org.apache.bcel.generic.Instruction

org.apache.bcel.generic.BranchInstruction

org.apache.bcel.generic.Select

All Implemented Interfaces:

Cloneable, InstructionTargeter, StackConsumer, StackProducer, VariableLengthInstruction

Direct Known Subclasses:

LOOKUPSWITCH, TABLESWITCH

public abstract class Select
extends BranchInstruction
implements VariableLengthInstruction, StackConsumer, StackProducer

Select - Abstract superclass for LOOKUPSWITCH and TABLESWITCH instructions.

We use our super's target property as the default target.

See Also:

• LOOKUPSWITCH
• TABLESWITCH
• InstructionList

Field Summary

Fields

Modifier and Type	Field	Description
protected int	fixed_length	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter
protected int[]	indices	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter
protected int[]	match	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter
protected int	match_length	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter
protected int	padding	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter
protected InstructionHandle[]	targets	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter

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
protected Object	clone()
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.
int[]	getIndices()	Gets the match target offsets.
int[]	getMatchs()	Gets the match indices.
InstructionHandle[]	getTargets()	Gets the match targets.
protected void	initFromFile(ByteSequence bytes, boolean wide)	Reads needed data (for example index) from file.
void	setTarget(int i, InstructionHandle target)	Sets branch target for 'i'th case.
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)	Since this is a variable length instruction, it may shift the following instructions which then need to update their position.
void	updateTarget(InstructionHandle oldIh, InstructionHandle newIh)	Replaces the target of this targeter from this old handle to the new handle.

Methods inherited from class BranchInstruction

getIndex, getPosition, getTarget, getTargetOffset, getTargetOffset, setIndex, setPosition, setTarget

Modifier and Type	Method	Description
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	setIndex(int index)	Sets the index.
protected void	setPosition(int position)	Sets the position.
void	setTarget(InstructionHandle target)	Sets branch target.

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

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.

Methods inherited from interface StackProducer

produceStack

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

Field Details

match

@Deprecated
protected int[] match

Deprecated.

(since 6.0) will be made private; do not access directly, use getter/setter

indices

@Deprecated
protected int[] indices

Deprecated.

(since 6.0) will be made private; do not access directly, use getter/setter

targets

@Deprecated
protected InstructionHandle[] targets

Deprecated.

(since 6.0) will be made private; do not access directly, use getter/setter

fixed_length

@Deprecated
protected int fixed_length

Deprecated.

(since 6.0) will be made private; do not access directly, use getter/setter

match_length

@Deprecated
protected int match_length

Deprecated.

(since 6.0) will be made private; do not access directly, use getter/setter

padding

@Deprecated
protected int padding

Deprecated.

(since 6.0) will be made private; do not access directly, use getter/setter

Method Details

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

containsTarget

public boolean containsTarget(InstructionHandle ih)

Description copied from interface: InstructionTargeter

Tests whether this targeter targets the specified instruction handle.

Specified by:

containsTarget in interface InstructionTargeter

Overrides:

containsTarget in class BranchInstruction

Parameters:

ih - The instruction handle to test.

Returns:

true, if ih is target of this instruction.

dump

public void dump(DataOutputStream out)
          throws IOException

Dumps instruction as byte code to stream out.

Overrides:

dump in class BranchInstruction

Parameters:

out - Output stream.

Throws:

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

getIndices

public int[] getIndices()

Gets the match target offsets.

Returns:

array of match target offsets.

getMatchs

public int[] getMatchs()

Gets the match indices.

Returns:

array of match indices.

getTargets

public InstructionHandle[] getTargets()

Gets the match targets.

Returns:

array of match targets.

initFromFile

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

Reads needed data (for example index) from file.

Overrides:

initFromFile in class BranchInstruction

Parameters:

bytes - input stream.

wide - wide prefix?

Throws:

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

See Also:

• InstructionList

setTarget

public void setTarget(int i,
 InstructionHandle target)

Sets branch target for 'i'th case.

Parameters:

i - The case index.

target - The branch target.

toString

public String toString(boolean verbose)

Description copied from class: BranchInstruction

Long output format: <position in byte code> <name of opcode> "["<opcode number>"]" "("<length of instruction>")" "<"<target instruction>">" "@"<branch target offset>

Overrides:

toString in class BranchInstruction

Parameters:

verbose - long/short format switch.

Returns:

mnemonic for instruction.

updatePosition

protected int updatePosition(int offset,
 int maxOffset)

Since this is a variable length instruction, it may shift the following instructions which then need to update their position. Called by InstructionList.setPositions when setting the position for every instruction. In the presence of variable length instructions 'setPositions' performs multiple passes over the instruction list to calculate the correct (byte) positions and offsets by calling this function.

Overrides:

updatePosition in class BranchInstruction

Parameters:

offset - additional offset caused by preceding (variable length) instructions.

maxOffset - The maximum offset that may be caused by these instructions.

Returns:

additional offset caused by possible change of this instruction's length.

updateTarget

public void updateTarget(InstructionHandle oldIh,
 InstructionHandle newIh)

Description copied from interface: InstructionTargeter

Replaces the target of this targeter from this old handle to the new handle.

Specified by:

updateTarget in interface InstructionTargeter

Overrides:

updateTarget in class BranchInstruction

Parameters:

oldIh - old target.

newIh - new target.