Record Class EconomyResult

java.lang.Object

java.lang.Record

fr.mathildeuh.youneedme.api.economy.EconomyResult

public record EconomyResult(EconomyResult.Status status, double balanceAfter, @Nullable String message)
extends Record

Outcome of a single economy operation, mirroring Vault's own success/failure-with-reason shape.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EconomyResult.Status

Constructor Summary

Constructors

Constructor	Description
EconomyResult(EconomyResult.Status status, double balanceAfter, @Nullable String message)	Creates an instance of a EconomyResult record class.

Method Summary

Modifier and Type	Method	Description
double	balanceAfter()	Returns the value of the balanceAfter record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static EconomyResult	failure(EconomyResult.Status status, double currentBalance, String message)
final int	hashCode()	Returns a hash code value for this object.
boolean	isSuccess()
@Nullable String	message()	Returns the value of the message record component.
EconomyResult.Status	status()	Returns the value of the status record component.
static EconomyResult	success(double balanceAfter)
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

EconomyResult

public EconomyResult(EconomyResult.Status status,
 double balanceAfter,
 @Nullable
 @Nullable String message)

Creates an instance of a EconomyResult record class.

Parameters:

status - the value for the status record component

balanceAfter - the value for the balanceAfter record component

message - the value for the message record component

Method Details

success

public static EconomyResult success(double balanceAfter)

failure

public static EconomyResult failure(EconomyResult.Status status,
 double currentBalance,
 String message)

isSuccess

public boolean isSuccess()

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.

status

public EconomyResult.Status status()

Returns the value of the status record component.

Returns:

the value of the status record component

balanceAfter

public double balanceAfter()

Returns the value of the balanceAfter record component.

Returns:

the value of the balanceAfter record component

message

@Nullable
public @Nullable String message()

Returns the value of the message record component.

Returns:

the value of the message record component