Record Class MachineDataKey<T>

java.lang.Object

java.lang.Record

fr.robie.machineengine.api.machine.MachineDataKey<T>

Record Components:

id - unique within the machine type

codec - how the value is persisted and migrated

defaultValue - the value of a newly placed machine

public record MachineDataKey<T>(@NotNull String id, @NotNull VersionedCodec<T> codec, T defaultValue)
extends Record

A persisted value of a machine's own state (counters, modes, settings). Declared on the MachineType; read and written through MachineContext.get(MachineDataKey)/MachineContext.set(MachineDataKey, T). Values must be immutable.

Constructor Summary

Constructors

Constructor	Description
MachineDataKey(@NotNull String id, @NotNull VersionedCodec<T> codec, T defaultValue)	Creates an instance of a MachineDataKey record class.

Method Summary

Modifier and Type	Method	Description
@NotNull VersionedCodec<T>	codec()	Returns the value of the codec record component.
T	defaultValue()	Returns the value of the defaultValue record component.
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 String	id()	Returns the value of the id record component.
static <T> @NotNull MachineDataKey<T>	of(@NotNull String id, @NotNull VersionedCodec<T> codec, T defaultValue)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

MachineDataKey

public MachineDataKey(@NotNull
 @NotNull String id,
 @NotNull
 @NotNull VersionedCodec<T> codec,
 @NotNull
 T defaultValue)

Creates an instance of a MachineDataKey record class.

Parameters:

id - the value for the id record component

codec - the value for the codec record component

defaultValue - the value for the defaultValue record component

Method Details

of

@NotNull
public static <T> @NotNull MachineDataKey<T> of(@NotNull
 @NotNull String id,
 @NotNull
 @NotNull VersionedCodec<T> codec,
 @NotNull
 T defaultValue)

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.

id

@NotNull
public @NotNull String id()

Returns the value of the id record component.

Returns:

the value of the id record component

codec

@NotNull
public @NotNull VersionedCodec<T> codec()

Returns the value of the codec record component.

Returns:

the value of the codec record component

defaultValue

@NotNull
public T defaultValue()

Returns the value of the defaultValue record component.

Returns:

the value of the defaultValue record component