Interface MachineError

All Known Implementing Classes:

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

public interface MachineError

An expected failure, returned in a Result instead of thrown (ARCHITECTURE.md §25). Exceptions are reserved for programmer errors.

The standard families are the nested records. Addons can define their own errors by implementing this interface with a code() in their namespace.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	MachineError.Generic	An error with a free-form code.
static final record	MachineError.InsufficientResource	Less than required was available.
static final record	MachineError.InvalidConfiguration	Invalid configuration value.
static final record	MachineError.InvalidDefinition	A definition (type, recipe, port …) is invalid.
static final record	MachineError.MissingResource	Something referenced by key is not registered (e.g.
static final record	MachineError.SerializationError	Data could not be encoded or decoded.
static final record	MachineError.TransferRejected	A handler refused a transfer.
static final record	MachineError.WrongThread	Called from a thread that does not own the target (§16).

Method Summary

Modifier and Type	Method	Description
@NotNull net.kyori.adventure.key.Key	code()	Stable machine-readable code, e.g.
default @NotNull Map<String,Object>	context()	Debugging details.
static @NotNull Map<String,Object>	details(@NotNull Object... keyValues)	Builds a context map from alternating keys and values.
default @NotNull String	format()
@NotNull String	message()
static @NotNull MachineError	of(@NotNull net.kyori.adventure.key.Key code, @NotNull String message)

Method Details

code

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

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

message

@NotNull
@NotNull String message()

context

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

Debugging details.

format

@NotNull
default @NotNull String format()

of

@NotNull
static @NotNull MachineError of(@NotNull
 @NotNull net.kyori.adventure.key.Key code,
 @NotNull
 @NotNull String message)

details

@NotNull
static @NotNull Map<String,Object> details(@NotNull
 @NotNull Object... keyValues)

Builds a context map from alternating keys and values.