Module club.doki7.ffm

Package club.doki7.ffm.ptr

Record Class ShortPtr

java.lang.Object

java.lang.Record

club.doki7.ffm.ptr.ShortPtr

All Implemented Interfaces:

IPointer, Iterable<Short>

@ValueBasedCandidate
@UnsafeConstructor
public record ShortPtr(@NotNull MemorySegment segment)
extends Record
implements IPointer, Iterable<Short>

Constructor Summary

Constructors

Constructor	Description
ShortPtr(@NotNull MemorySegment segment)	Creates an instance of a ShortPtr record class.

Method Summary

Modifier and Type	Method	Description
static @NotNull ShortPtr	allocate(@NotNull Arena arena)
static @NotNull ShortPtr	allocate(@NotNull Arena arena, long size)
static @NotNull ShortPtr	allocate(@NotNull Arena arena, short @NotNull [] array)
static @NotNull ShortPtr	allocate(@NotNull Arena arena, @NotNull ShortBuffer buffer)
static @NotNull ShortPtr	allocate(@NotNull Arena arena, Collection<Short> shorts)
static @NotNull ShortPtr	allocateV(@NotNull Arena arena, short value0, short... values)
static @Nullable ShortPtr	checked(@NotNull MemorySegment segment)
static @NotNull ShortPtr	checked(@NotNull ShortBuffer buffer)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@NotNull Iterator<Short>	iterator()
@NotNull ShortPtr	offset(long offset)
short	read()
short	read(long index)
@NotNull ShortPtr	reinterpret(long newSize)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
@NotNull ShortPtr	slice(long end)
@NotNull ShortPtr	slice(long start, long end)
final String	toString()	Returns a string representation of this record class.
void	write(long index, short value)
void	write(short value)
void	write(short @NotNull [] values)
void	writeV(short value0, short @NotNull ... values)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ShortPtr

public ShortPtr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a ShortPtr record class.

Parameters:

segment - the value for the segment record component

Method Details

size

public long size()

read

public short read()

write

public void write(short value)

read

public short read(long index)

write

public void write(long index,
 short value)

write

public void write(short @NotNull [] values)

writeV

public void writeV(short value0,
 short @NotNull ... values)

reinterpret

@Unsafe
@NotNull
public @NotNull ShortPtr reinterpret(long newSize)

offset

@NotNull
public @NotNull ShortPtr offset(long offset)

slice

@NotNull
public @NotNull ShortPtr slice(long start,
 long end)

slice

@NotNull
public @NotNull ShortPtr slice(long end)

iterator

@NotNull
public @NotNull Iterator<Short> iterator()

Specified by:

iterator in interface Iterable<Short>

checked

@Nullable
public static @Nullable ShortPtr checked(@NotNull
 @NotNull MemorySegment segment)

checked

@NotNull
public static @NotNull ShortPtr checked(@NotNull
 @NotNull ShortBuffer buffer)

allocate

@NotNull
public static @NotNull ShortPtr allocate(@NotNull
 @NotNull Arena arena)

allocate

@NotNull
public static @NotNull ShortPtr allocate(@NotNull
 @NotNull Arena arena,
 long size)

allocate

@NotNull
public static @NotNull ShortPtr allocate(@NotNull
 @NotNull Arena arena,
 short @NotNull [] array)

allocate

@NotNull
public static @NotNull ShortPtr allocate(@NotNull
 @NotNull Arena arena,
 Collection<Short> shorts)

allocateV

@NotNull
public static @NotNull ShortPtr allocateV(@NotNull
 @NotNull Arena arena,
 short value0,
 short... values)

allocate

@NotNull
public static @NotNull ShortPtr allocate(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull ShortBuffer buffer)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

segment

@NotNull
public @NotNull MemorySegment segment()

Returns the value of the segment record component.

Specified by:

segment in interface IPointer

Returns:

the value of the segment record component