OpenJDK 27 · java.lang.classfile.instruction.StoreInstruction

Models a local variable store instruction in the code array of a Code attribute. Corresponding opcodes have a kind of Opcode.Kind#STORE. Delivered as a CodeElement when traversing the elements of a CodeModel.

A local variable store instruction is composite:

StoreInstruction(
    TypeKind typeKind,
    int slot
)

where TypeKind is computational, and slot is u2.

astore series of instructions, or reference type store instructions, can also operate on the returnAddress type from discontinued jump subroutine instructions.

Method Summary

Modifier and Type	Method and Description
public static StoreInstruction	Returns: a local variable store instruction of(TypeKind the type of the value to be stored kind, int the local variable slot to store to slot) Returns a local variable store instruction.
public static StoreInstruction	Returns: a local variable store instruction of(Opcode the opcode for the specific type of store instruction, which must be of kind `Opcode.Kind#STORE` op, int the local variable slot to store to slot) Returns a local variable store instruction.
public int	Returns: the local variable slot to store to slot() Returns the local variable slot to store to.
public TypeKind	Returns: the computational type of the value to be stored typeKind() Returns the computational type of the value to be stored.

Inherited from java.lang.classfile.Instruction:: opcode sizeInBytes

Method Detail

of back to summary

of	back to summary
public static StoreInstruction of(TypeKind kind, int slot) Returns a local variable store instruction. `kind` is converted to its computational type. `slot` must be `u2`. Parameters kind:TypeKind the type of the value to be stored slot:int the local variable slot to store to Returns:StoreInstruction a local variable store instruction Exceptions IllegalArgumentException: if `kind` is `void` or `slot` is not `u2`

public static StoreInstruction of(TypeKind kind, int slot)

Returns a local variable store instruction. kind is converted to its computational type. slot must be u2.

Parameters

kind:TypeKind: the type of the value to be stored
slot:int: the local variable slot to store to

Returns:StoreInstruction

a local variable store instruction

Exceptions

IllegalArgumentException:: if kind is void or slot is not u2

of back to summary

of	back to summary
public static StoreInstruction of(Opcode op, int slot) Returns a local variable store instruction. The range of `slot` is restricted by the `op` and its size: If `op` has size 1, `slot` must be exactly the slot value implied by the opcode. If `op` has size 2, `slot` must be `u1`. If `op` has size 4, `slot` must be `u2`. API Note The explicit `op` argument allows creating `wide` or regular store instructions when the `slot` can be encoded with more optimized store instructions. Parameters op:Opcode the opcode for the specific type of store instruction, which must be of kind `Opcode.Kind#STORE` slot:int the local variable slot to store to Returns:StoreInstruction a local variable store instruction Exceptions IllegalArgumentException: if the opcode kind is not `Opcode.Kind#STORE` or `slot` is out of range

public static StoreInstruction of(Opcode op, int slot)

Returns a local variable store instruction.

The range of slot is restricted by the op and its size:

If op has size 1, slot must be exactly the slot value implied by the opcode.
If op has size 2, slot must be u1.
If op has size 4, slot must be u2.

API Note

The explicit op argument allows creating wide or regular store instructions when the slot can be encoded with more optimized store instructions.

Parameters

op:Opcode: the opcode for the specific type of store instruction, which must be of kind Opcode.Kind#STORE
slot:int: the local variable slot to store to

Returns:StoreInstruction

a local variable store instruction

Exceptions

IllegalArgumentException:: if the opcode kind is not Opcode.Kind#STORE or slot is out of range

slot back to summary

slot	back to summary
public int slot() Returns the local variable slot to store to. It is a `u2` value. Returns:int the local variable slot to store to

public int slot()

Returns the local variable slot to store to. It is a u2 value.

Returns:int: the local variable slot to store to

typeKind back to summary

typeKind	back to summary
public TypeKind typeKind() Returns the computational type of the value to be stored. The `reference` type store instructions also operate on the `returnAddress` type, which does not apply to `reference` type load instructions. Returns:TypeKind the computational type of the value to be stored

public TypeKind typeKind()

Returns the computational type of the value to be stored. The reference type store instructions also operate on the returnAddress type, which does not apply to reference type load instructions.

Returns:TypeKind: the computational type of the value to be stored

public sealed Interface StoreInstruction

Method Summary

Method Detail