Record Class MachineError.Generic

java.lang.Object

java.lang.Record

fr.robie.machineengine.api.error.MachineError.Generic

All Implemented Interfaces:

MachineError

Enclosing interface:

MachineError

public static record MachineError.Generic(@NotNull net.kyori.adventure.key.Key code, @NotNull String message, @NotNull Map<String,Object> context)
extends Record
implements MachineError

An error with a free-form code.

Nested Class Summary

Nested classes/interfaces inherited from interface MachineError

MachineError.Generic, MachineError.InsufficientResource, MachineError.InvalidConfiguration, MachineError.InvalidDefinition, MachineError.MissingResource, MachineError.SerializationError, MachineError.TransferRejected, MachineError.WrongThread

Constructor Summary

Constructors

Constructor	Description
Generic(@NotNull net.kyori.adventure.key.Key code, @NotNull String message, @NotNull Map<String,Object> context)	Creates an instance of a Generic record class.

Method Summary

Modifier and Type	Method	Description
@NotNull net.kyori.adventure.key.Key	code()	Returns the value of the code record component.
@NotNull Map<String,Object>	context()	Returns the value of the context 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	message()	Returns the value of the message record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface MachineError

format

Constructor Details

Generic

public Generic(@NotNull
 @NotNull net.kyori.adventure.key.Key code,
 @NotNull
 @NotNull String message,
 @NotNull
 @NotNull Map<String,Object> context)

Creates an instance of a Generic record class.

Parameters:

code - the value for the code record component

message - the value for the message record component

context - the value for the context record component

Method Details

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.

code

@NotNull
public @NotNull net.kyori.adventure.key.Key code()

Returns the value of the code record component.

Specified by:

code in interface MachineError

Returns:

the value of the code record component

message

@NotNull
public @NotNull String message()

Returns the value of the message record component.

Specified by:

message in interface MachineError

Returns:

the value of the message record component

context

@NotNull
public @NotNull Map<String,Object> context()

Returns the value of the context record component.

Specified by:

context in interface MachineError

Returns:

the value of the context record component