Class TransferResult

java.lang.Object

me.internalizable.numdrassl.api.player.TransferResult

public final class TransferResult
extends Object

Result of a player transfer attempt.

Method Summary

Modifier and Type	Method	Description
static TransferResult	failure(String reason)	Create a failed transfer result.
String	getMessage()	Get the result message.
boolean	isSuccess()	Check if the transfer was successful.
static TransferResult	success()	Create a successful transfer result.
static TransferResult	success(String message)	Create a successful transfer result with a message.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

isSuccess

public boolean isSuccess()

Check if the transfer was successful.

Returns:

true if successful

getMessage

@Nullable
public String getMessage()

Get the result message.

Returns:

the message describing the result

success

public static TransferResult success()

Create a successful transfer result.

Returns:

a success result

success

public static TransferResult success(@Nonnull
 String message)

Create a successful transfer result with a message.

Parameters:

message - the success message

Returns:

a success result

failure

public static TransferResult failure(@Nonnull
 String reason)

Create a failed transfer result.

Parameters:

reason - the reason for failure

Returns:

a failure result