Record Class MachineError.InsufficientResource

java.lang.Object

java.lang.Record

fr.robie.machineengine.api.error.MachineError.InsufficientResource

All Implemented Interfaces:

MachineError

Enclosing interface:

MachineError

public static record MachineError.InsufficientResource(@NotNull net.kyori.adventure.key.Key resource, long required, long available)
extends Record
implements MachineError

Less than required was available.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final net.kyori.adventure.key.Key	CODE

Constructor Summary

Constructors

Constructor	Description
InsufficientResource(@NotNull net.kyori.adventure.key.Key resource, long required, long available)	Creates an instance of a InsufficientResource record class.

Method Summary

Modifier and Type	Method	Description
long	available()	Returns the value of the available record component.
@NotNull net.kyori.adventure.key.Key	code()	Stable machine-readable code, e.g.
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()
long	required()	Returns the value of the required record component.
@NotNull net.kyori.adventure.key.Key	resource()	Returns the value of the resource 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

context, format

Field Details

CODE

public static final net.kyori.adventure.key.Key CODE

Constructor Details

InsufficientResource

public InsufficientResource(@NotNull
 @NotNull net.kyori.adventure.key.Key resource,
 long required,
 long available)

Creates an instance of a InsufficientResource record class.

Parameters:

resource - the value for the resource record component

required - the value for the required record component

available - the value for the available record component

Method Details

code

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

Description copied from interface: MachineError

Stable machine-readable code, e.g. machineengine:insufficient_resource.

Specified by:

code in interface MachineError

message

@NotNull
public @NotNull String message()

Specified by:

message in interface MachineError

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

resource

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

Returns the value of the resource record component.

Returns:

the value of the resource record component

required

public long required()

Returns the value of the required record component.

Returns:

the value of the required record component

available

public long available()

Returns the value of the available record component.

Returns:

the value of the available record component