Package dev.mintychochip.mint

Interface TransactionContext

@AvailableSince("1.0")
public sealed interface TransactionContext

Sealed interface providing audit metadata about a transaction's initiator.

Tracks who initiated a transaction and optionally why, enabling audit trails and transaction attribution.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TransactionContext.Actor	Represents the initiator of a transaction.
static final record	TransactionContext.PlayerActor	Actor implementation for player-initiated transactions.
static final record	TransactionContext.PluginActor	Actor implementation for plugin-initiated transactions.

Method Summary

Modifier and Type	Method	Description
@NotNull TransactionContext.Actor	actor()	Returns the entity that initiated this transaction.
static TransactionContext	create(TransactionContext.Actor actor, @Nullable String reason)
@NotNull Optional<String>	reason()	Returns the optional human-readable justification for this transaction.

Method Details

create

static TransactionContext create(TransactionContext.Actor actor,
 @Nullable
 @Nullable String reason)

actor

@NotNull
@NotNull TransactionContext.Actor actor()

Returns the entity that initiated this transaction.

Returns:

the transaction actor

reason

@NotNull
@NotNull Optional<String> reason()

Returns the optional human-readable justification for this transaction.

Returns:

optional reason string