Record Class Mapping.Char

java.lang.Object

java.lang.Record

org.lwjgl.system.ffm.mapping.Mapping.Char

All Implemented Interfaces:

DataMapping<ValueLayout.OfChar>, IntegerMapping<ValueLayout.OfChar>, Mapping<ValueLayout.OfChar>, PrimitiveMapping<ValueLayout.OfChar>

Enclosing interface:

Mapping<L extends MemoryLayout>

public static record Mapping.Char(ValueLayout.OfChar layout, Mapping.Pointer p)
extends Record
implements IntegerMapping<ValueLayout.OfChar>

Mapping from ValueLayout.JAVA_CHAR to C uint16_t.

Nested Class Summary

Nested classes/interfaces inherited from interface Mapping

Mapping.Boolean, Mapping.Byte, Mapping.Char, Mapping.CLong, Mapping.Double, Mapping.Float, Mapping.Int, Mapping.Long, Mapping.Opaque, Mapping.Pointer, Mapping.Sequence, Mapping.Short, Mapping.Size, Mapping.Struct, Mapping.Union

Constructor Summary

Constructors

Constructor	Description
Char(ValueLayout.OfChar layout, Mapping.Pointer p)	Creates an instance of a Char record class.

Method Summary

Modifier and Type	Method	Description
Mapping.Char	cconst()	Creates a new instance of this mapping with the C const qualifier
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
char	get(MemorySegment segment, long offset)
char	getAligned(MemorySegment segment, long offset)
char	getAtIndex(MemorySegment segment, long index)
char	getAtIndexAligned(MemorySegment segment, long index)
final int	hashCode()	Returns a hash code value for this object.
ValueLayout.OfChar	layout()	Returns the value of the layout record component.
Mapping.Pointer	p()	Returns the value of the p record component.
Mapping.Char	set(MemorySegment segment, long offset, char value)
Mapping.Char	setAligned(MemorySegment segment, long offset, char value)
Mapping.Char	setAtIndex(MemorySegment segment, long index, char value)
Mapping.Char	setAtIndexAligned(MemorySegment segment, long index, char value)
boolean	signed()	Returns whether the integer is signed (true) or unsigned (false).
final String	toString()	Returns a string representation of this record class.
Mapping.Char	typedef(String name)	Creates a new instance of this mapping with the specified type name.
Mapping.Char	withByteAlignment(long byteAlignment)	Returns a copy of this mapping with the specified byte alignment.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface DataMapping

allocateSegment, allocateSegment, allocateSegment, allocateSegment, array, mallocSegment, mallocSegment

Constructor Details

Char

public Char(ValueLayout.OfChar layout,
 Mapping.Pointer p)

Creates an instance of a Char record class.

Parameters:

layout - the value for the layout record component

p - the value for the p record component

Method Details

signed

public boolean signed()

Description copied from interface: IntegerMapping

Returns whether the integer is signed (true) or unsigned (false).

Specified by:

signed in interface IntegerMapping<ValueLayout.OfChar>

Returns:

whether the integer is signed

withByteAlignment

public Mapping.Char withByteAlignment(long byteAlignment)

Description copied from interface: DataMapping

Returns a copy of this mapping with the specified byte alignment.

Specified by:

withByteAlignment in interface DataMapping<ValueLayout.OfChar>

Specified by:

withByteAlignment in interface PrimitiveMapping<ValueLayout.OfChar>

Parameters:

byteAlignment - the new byte alignment

Returns:

the new mapping

typedef

public Mapping.Char typedef(String name)

Description copied from interface: Mapping

Creates a new instance of this mapping with the specified type name.

Specified by:

typedef in interface IntegerMapping<ValueLayout.OfChar>

Specified by:

typedef in interface Mapping<ValueLayout.OfChar>

Specified by:

typedef in interface PrimitiveMapping<ValueLayout.OfChar>

Returns:

the new mapping

cconst

public Mapping.Char cconst()

Description copied from interface: Mapping

Creates a new instance of this mapping with the C const qualifier

Specified by:

cconst in interface Mapping<ValueLayout.OfChar>

Returns:

the new mapping

get

public char get(MemorySegment segment,
 long offset)

getAtIndex

public char getAtIndex(MemorySegment segment,
 long index)

getAligned

public char getAligned(MemorySegment segment,
 long offset)

getAtIndexAligned

public char getAtIndexAligned(MemorySegment segment,
 long index)

set

public Mapping.Char set(MemorySegment segment,
 long offset,
 char value)

setAtIndex

public Mapping.Char setAtIndex(MemorySegment segment,
 long index,
 char value)

setAligned

public Mapping.Char setAligned(MemorySegment segment,
 long offset,
 char value)

setAtIndexAligned

public Mapping.Char setAtIndexAligned(MemorySegment segment,
 long index,
 char value)

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.

layout

public ValueLayout.OfChar layout()

Returns the value of the layout record component.

Specified by:

layout in interface Mapping<ValueLayout.OfChar>

Returns:

the value of the layout record component

p

public Mapping.Pointer p()

Returns the value of the p record component.

Specified by:

p in interface Mapping<ValueLayout.OfChar>

Returns:

the value of the p record component