APIdia Launch Partner
Top Fields Constructors Methods
jdk.internal.foreign.abi

public final Record VMStorage

extends Record
Class Inheritance
Record Components
type:byte
the type of storage. e.g. stack, or which register type (GP, FP, vector)
segmentMaskOrSize:short
the (on stack) size in bytes when type = stack, a register mask otherwise, the register mask indicates which segments of a register are used.
indexOrOffset:int
the index is either a register number within a type, or a stack offset in bytes if type = stack. (a particular platform might add a bias to this in generate code)
debugName:String
the debug name, mostly derived from type
Imports
java.util.Objects

Field Summary

Modifier and TypeField and Description
private final String
debugName

Record Component accessed by debugName().

the debug name, mostly derived from type
private final int
indexOrOffset

Record Component accessed by indexOrOffset().

the index is either a register number within a type, or a stack offset in bytes if type = stack.
private final short
segmentMaskOrSize

Record Component accessed by segmentMaskOrSize().

the (on stack) size in bytes when type = stack, a register mask otherwise, the register mask indicates which segments of a register are used.
private final byte
type

Record Component accessed by type().

the type of storage.

Constructor Summary

AccessConstructor and Description
public
VMStorage(byte type, short segmentMaskOrSize, int indexOrOffset)

public
VMStorage(byte type, short segmentMaskOrSize, int indexOrOffset, String debugName)

Method Summary

Modifier and TypeMethod and Description
public String
debugName()

Record Component getter of debugName.

Record Component the debug name, mostly derived from type

public boolean
equals(Object obj)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public int
indexOrOffset()

Record Component getter of indexOrOffset.

Record Component the index is either a register number within a type, or a stack offset in bytes if type = stack.

public short
segmentMaskOrSize()

Record Component getter of segmentMaskOrSize.

Record Component the (on stack) size in bytes when type = stack, a register mask otherwise, the register mask indicates which segments of a register are used.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

public byte
type()

Record Component getter of type.

Record Component the type of storage.

Field Detail

debugNameback to summary
private final String debugName

Record Component accessed by debugName().

the debug name, mostly derived from type

indexOrOffsetback to summary
private final int indexOrOffset

Record Component accessed by indexOrOffset().

the index is either a register number within a type, or a stack offset in bytes if type = stack. (a particular platform might add a bias to this in generate code)

segmentMaskOrSizeback to summary
private final short segmentMaskOrSize

Record Component accessed by segmentMaskOrSize().

the (on stack) size in bytes when type = stack, a register mask otherwise, the register mask indicates which segments of a register are used.

typeback to summary
private final byte type

Record Component accessed by type().

the type of storage. e.g. stack, or which register type (GP, FP, vector)

Constructor Detail

VMStorageback to summary
public VMStorage(byte type, short segmentMaskOrSize, int indexOrOffset)
VMStorageback to summary
public VMStorage(byte type, short segmentMaskOrSize, int indexOrOffset, String debugName)

Method Detail

debugNameback to summary
public String debugName()

Record Component getter of debugName.

Record Component
the debug name, mostly derived from type
equalsback to summary
public boolean equals(Object obj)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: 

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
Annotations
@Override
hashCodeback to summary
public int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Annotations
@Override
indexOrOffsetback to summary
public int indexOrOffset()

Record Component getter of indexOrOffset.

Record Component
the index is either a register number within a type, or a stack offset in bytes if type = stack. (a particular platform might add a bias to this in generate code)
segmentMaskOrSizeback to summary
public short segmentMaskOrSize()

Record Component getter of segmentMaskOrSize.

Record Component
the (on stack) size in bytes when type = stack, a register mask otherwise, the register mask indicates which segments of a register are used.
toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

typeback to summary
public byte type()

Record Component getter of type.

Record Component
the type of storage. e.g. stack, or which register type (GP, FP, vector)