Package org.apache.bcel.generic
Class Instruction
java.lang.Object
org.apache.bcel.generic.Instruction
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
ACONST_NULL,ArithmeticInstruction,ArrayInstruction,ARRAYLENGTH,ATHROW,BIPUSH,BranchInstruction,BREAKPOINT,ConversionInstruction,CPInstruction,DCMPG,DCMPL,DCONST,FCMPG,FCMPL,FCONST,ICONST,IMPDEP1,IMPDEP2,LCMP,LCONST,LocalVariableInstruction,MONITORENTER,MONITOREXIT,NEWARRAY,NOP,RET,ReturnInstruction,SIPUSH,StackInstruction
Abstract super class for all Java byte codes.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static InstructionComparator(package private) static final Instruction[]protected shortDeprecated.(since 6.0) will be made private; do not access directly, use getter/setterprotected shortDeprecated.(since 6.0) will be made private; do not access directly, use getter/setter -
Constructor Summary
ConstructorsConstructorDescriptionEmpty constructor needed for Instruction.readInstruction.Instruction(short opcode, short length) Constructs an Instruction. -
Method Summary
Modifier and TypeMethodDescriptionabstract voidCall corresponding visitor method(s).intThis method also gives right results for instructions whose effect on the stack depends on the constant pool entry they reference.copy()Use with caution, since 'BranchInstruction's have a 'target' reference which is not copied correctly (only basic types are).(package private) voiddispose()Some instructions may be reused, so don't do anything by default.voiddump(DataOutputStream out) Dumps instruction as byte code to stream out.(package private) byte[]Dumps this instruction to a byte array.booleanTests for equality, delegated to comparatorstatic InstructionComparatorDeprecated.(6.0) use the built in comparator, or wrap this class in another object that implements these methodsintGets the length (in bytes) of instruction.getName()Gets the name of instruction, that is, opcode name.shortGets this instruction's opcode.inthashCode()Gets the hashCode of this object.protected voidinitFromFile(ByteSequence bytes, boolean wide) Reads needed data (for example index) from file.(package private) static booleanisNonNegativeUShort(int value) Tests if the value can fit in a non-negative short.static booleanisValidByte(int value) Tests if the value can fit in a byte (signed).static booleanisValidShort(int value) Tests if the value can fit in a short (signed).intThis method also gives right results for instructions whose effect on the stack depends on the constant pool entry they reference.(package private) static InstructionreadInstruction(byte[] code) Reads an instruction from (byte code) input stream and return the appropriate object.static InstructionreadInstruction(ByteSequence bytes) Reads an instruction from (byte code) input stream and return the appropriate object.static voidDeprecated.(6.0) use the built in comparator, or wrap this class in another object that implements these methods(package private) final voidsetLength(int length) Needed in readInstruction and subclasses in this package(package private) final voidsetOpcode(short opcode) Needed in readInstruction and subclasses in this package.toString()toString(boolean verbose) Long output format: <name of opcode> "["<opcode number>"]" "("<length of instruction>")"toString(ConstantPool cp) Gets the mnemonic for instruction with symbolic references resolved.
-
Field Details
-
EMPTY_ARRAY
-
cmp
-
length
Deprecated.(since 6.0) will be made private; do not access directly, use getter/setter -
opcode
Deprecated.(since 6.0) will be made private; do not access directly, use getter/setter
-
-
Constructor Details
-
Instruction
Instruction()Empty constructor needed for Instruction.readInstruction. Not to be used otherwise. -
Instruction
public Instruction(short opcode, short length) Constructs an Instruction.- Parameters:
opcode- The opcode.length- The instruction length.
-
-
Method Details
-
getComparator
Deprecated.(6.0) use the built in comparator, or wrap this class in another object that implements these methodsGets Comparator object used in the equals() method to determine equality of instructions.- Returns:
- currently used comparator for equals().
-
isNonNegativeUShort
static boolean isNonNegativeUShort(int value) Tests if the value can fit in a non-negative short.- Parameters:
value- The value to check.- Returns:
- true if the value is in range.
-
isValidByte
public static boolean isValidByte(int value) Tests if the value can fit in a byte (signed).- Parameters:
value- The value to check.- Returns:
- true if the value is in range.
- Since:
- 6.0
-
isValidShort
public static boolean isValidShort(int value) Tests if the value can fit in a short (signed).- Parameters:
value- The value to check.- Returns:
- true if the value is in range.
- Since:
- 6.0
-
readInstruction
Reads an instruction from (byte code) input stream and return the appropriate object.- Parameters:
code- byte array containing the instruction to read.- Returns:
- instruction object being read.
- Throws:
IOException- Thrown when an I/O exception of some sort has occurred.
-
readInstruction
Reads an instruction from (byte code) input stream and return the appropriate object.If the Instruction is defined in
InstructionConst, then the singleton instance is returned.- Parameters:
bytes- input stream bytes.- Returns:
- instruction object being read.
- Throws:
IOException- Thrown when an I/O exception of some sort has occurred.- See Also:
-
setComparator
Deprecated.(6.0) use the built in comparator, or wrap this class in another object that implements these methodsSets comparator to be used for equals().- Parameters:
c- The comparator.
-
accept
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.- Parameters:
v- Visitor object.
-
consumeStack
This method also gives right results for instructions whose effect on the stack depends on the constant pool entry they reference.- Parameters:
cpg- The constant pool generator.- Returns:
- Number of words consumed from stack by this instruction, or Constants.UNPREDICTABLE, if this cannot be computed statically.
-
copy
Use with caution, since 'BranchInstruction's have a 'target' reference which is not copied correctly (only basic types are). This also applies for 'Select' instructions with their multiple branch targets.- Returns:
- (shallow) copy of an instruction.
- See Also:
-
dispose
void dispose()Some instructions may be reused, so don't do anything by default. -
dump
Dumps instruction as byte code to stream out.- Parameters:
out- Output stream.- Throws:
IOException- Thrown when an I/O exception of some sort has occurred.
-
dumpToByteArray
Dumps this instruction to a byte array.- Returns:
- the byte array containing the dumped instruction
- Throws:
IOException- Thrown if an I/O error occurs.
-
equals
Tests for equality, delegated to comparator -
getLength
public int getLength()Gets the length (in bytes) of instruction.- Returns:
- length (in bytes) of instruction.
-
getName
Gets the name of instruction, that is, opcode name.- Returns:
- name of instruction, that is, opcode name.
-
getOpcode
public short getOpcode()Gets this instruction's opcode.- Returns:
- this instruction's opcode.
-
hashCode
public int hashCode()Gets the hashCode of this object. -
initFromFile
Reads needed data (for example index) from file.- Parameters:
bytes- byte sequence to read from.wide- "wide" instruction flag.- Throws:
IOException- Thrown if the implementation needs to read data from the file
-
produceStack
This method also gives right results for instructions whose effect on the stack depends on the constant pool entry they reference.- Parameters:
cpg- The constant pool generator.- Returns:
- Number of words produced onto stack by this instruction, or Constants.UNPREDICTABLE, if this cannot be computed statically.
-
setLength
final void setLength(int length) Needed in readInstruction and subclasses in this package- Since:
- 6.0
-
setOpcode
final void setOpcode(short opcode) Needed in readInstruction and subclasses in this package. -
toString
-
toString
Long output format: <name of opcode> "["<opcode number>"]" "("<length of instruction>")"- Parameters:
verbose- long/short format switch.- Returns:
- mnemonic for instruction.
-
toString
Gets the mnemonic for instruction with symbolic references resolved.- Parameters:
cp- The constant pool.- Returns:
- mnemonic for instruction with symbolic references resolved.
-