Class PUTFIELD

java.lang.Object

org.apache.bcel.generic.Instruction

org.apache.bcel.generic.CPInstruction

org.apache.bcel.generic.FieldOrMethod

org.apache.bcel.generic.FieldInstruction

org.apache.bcel.generic.PUTFIELD

All Implemented Interfaces:

Cloneable, ExceptionThrower, IndexedInstruction, LoadClass, PopInstruction, StackConsumer, TypedInstruction

public class PUTFIELD
extends FieldInstruction
implements PopInstruction, ExceptionThrower

PUTFIELD - Put field in object

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

OR

Stack: ..., objectref, value.word1, value.word2 -> ...

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
PUTFIELD(int index)	Constructs a PUTFIELD instruction.

Method Summary

Modifier and Type	Method	Description
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.
Class<?>[]	getExceptions()	Gets the exceptions that may be thrown by this instruction.

Methods inherited from class FieldInstruction

getFieldName, getFieldSize, getFieldType, getType, toString

Modifier and Type	Method	Description
String	getFieldName(ConstantPoolGen cpg)	Gets the name of referenced field.
protected int	getFieldSize(ConstantPoolGen cpg)	Gets the size of field.
Type	getFieldType(ConstantPoolGen cpg)	Gets the type of field.
Type	getType(ConstantPoolGen cpg)	Gets the type of the referenced field.
String	toString(ConstantPool cp)	Gets the mnemonic for instruction with symbolic references resolved.

Methods inherited from class FieldOrMethod

getClassName, getClassType, getLoadClassType, getName, getReferenceType, getSignature

Modifier and Type	Method	Description
String	getClassName(ConstantPoolGen cpg)	Deprecated. If the instruction references an array class, this method will return "java.lang.Object".
ObjectType	getClassType(ConstantPoolGen cpg)	Deprecated. If the instruction references an array class, the ObjectType returned will be invalid.
ObjectType	getLoadClassType(ConstantPoolGen cpg)	Gets the ObjectType of the method return or field.
String	getName(ConstantPoolGen cpg)	Gets the name of referenced method or field.
ReferenceType	getReferenceType(ConstantPoolGen cpg)	Gets the reference type representing the class, interface, or array class referenced by the instruction.
String	getSignature(ConstantPoolGen cpg)	Gets the signature of referenced method or field.

Methods inherited from class CPInstruction

dump, getIndex, initFromFile, setIndex, 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.
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>">"

Methods inherited from class Instruction

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

Modifier and Type	Method	Description
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

Constructor Details

PUTFIELD

public PUTFIELD(int index)

Constructs a PUTFIELD instruction.

Parameters:

index - index into 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.

consumeStack

public int consumeStack(ConstantPoolGen cpg)

Description copied from class: Instruction

This method also gives right results for instructions whose effect on the stack depends on the constant pool entry they reference.

Specified by:

consumeStack in interface StackConsumer

Overrides:

consumeStack in class Instruction

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.

getExceptions

public Class<?>[] getExceptions()

Description copied from interface: ExceptionThrower

Gets the exceptions that may be thrown by this instruction.

Specified by:

getExceptions in interface ExceptionThrower

Returns:

The exceptions that may be thrown by this instruction.