Class CHECKCAST

java.lang.Object

org.apache.bcel.generic.Instruction

org.apache.bcel.generic.CPInstruction

org.apache.bcel.generic.CHECKCAST

All Implemented Interfaces:

Cloneable, ExceptionThrower, IndexedInstruction, LoadClass, StackConsumer, StackProducer, TypedInstruction

public class CHECKCAST
extends CPInstruction
implements LoadClass, ExceptionThrower, StackProducer, StackConsumer

CHECKCAST - Check whether object is of given type

Stack: ..., objectref -> ..., objectref

Field Summary

Fields inherited from class CPInstruction

index

Modifier and Type	Field	Description
protected int	index	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

Constructor Summary

Constructors

Constructor	Description
CHECKCAST(int index)	Check whether object is of given type

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor v)	Call corresponding visitor method(s).
Class<?>[]	getExceptions()	Gets the exceptions this instruction may cause.
ObjectType	getLoadClassType(ConstantPoolGen cpg)	Gets the ObjectType of the referenced class or interface that may be loaded and resolved.

Methods inherited from class CPInstruction

dump, getIndex, getType, initFromFile, setIndex, toString, toString

Modifier and Type	Method	Description
void	dump(DataOutputStream out)	Dumps instruction as byte code to stream out.
final int	getIndex()	Gets the constant pool index referred to by this instruction.
Type	getType(ConstantPoolGen cpg)	Gets the type associated with this instruction.
protected void	initFromFile(ByteSequence bytes, boolean wide)	Reads needed data (that is, index) from file.
void	setIndex(int index)	Sets the index to constant pool.
String	toString(boolean verbose)	Long output format: <name of opcode> "["<opcode number>"]" "("<length of instruction>")" "<"< constant pool index>">"
String	toString(ConstantPool cp)	Gets the mnemonic for instruction with symbolic references resolved.

Methods inherited from class Instruction

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

Methods inherited from class Object

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

Methods inherited from interface LoadClass

getType

Modifier and Type	Method	Description
Type	getType(ConstantPoolGen cpg)	Gets the type associated with this instruction.

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.

Constructor Details

CHECKCAST

public CHECKCAST(int index)

Check whether object is of given type

Parameters:

index - index to class in constant pool.

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.

getExceptions

public Class<?>[] getExceptions()

Gets the exceptions this instruction may cause.

Specified by:

getExceptions in interface ExceptionThrower

Returns:

exceptions this instruction may cause.

getLoadClassType

public ObjectType getLoadClassType(ConstantPoolGen cpg)

Description copied from interface: LoadClass

Gets the ObjectType of the referenced class or interface that may be loaded and resolved.

Specified by:

getLoadClassType in interface LoadClass

Parameters:

cpg - A ConstantPoolGen.

Returns:

object type that may be loaded or null if a primitive is referenced.