net.luckperms.api.model

Interface PlayerSaveResult

public interface PlayerSaveResult

Encapsulates the result of an operation to save uuid data about a player.

The corresponding method can be found at UserManager.savePlayerData(UUID, String).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PlayerSaveResult.Outcome The various states the result can take

Method Summary

Modifier and Type	Method and Description
@Nullable Set<UUID>	getOtherUniqueIds() Gets the other uuids involved in the result.
@NonNull Set<PlayerSaveResult.Outcome>	getOutcomes() Gets the status returned by the operation
@Nullable String	getPreviousUsername() Gets the previous username involved in the result.
default boolean	includes(@NonNull PlayerSaveResult.Outcome outcome) Gets if the result includes a certain outcome.

Method Detail

getOutcomes

@NonNull Set<PlayerSaveResult.Outcome> getOutcomes()

Gets the status returned by the operation

Returns:

the status

includes

default boolean includes(@NonNull PlayerSaveResult.Outcome outcome)

Gets if the result includes a certain outcome.

Parameters:

outcome - the outcome to check for

Returns:

if the result includes the outcome

getPreviousUsername

@Nullable String getPreviousUsername()

Gets the previous username involved in the result.

Returns null when the result doesn't include the PlayerSaveResult.Outcome.USERNAME_UPDATED status.

Returns:

the previous username

See Also:

PlayerSaveResult.Outcome.USERNAME_UPDATED

getOtherUniqueIds

@Nullable Set<UUID> getOtherUniqueIds()

Gets the other uuids involved in the result.

Returns null when the result doesn't include the PlayerSaveResult.Outcome.OTHER_UNIQUE_IDS_PRESENT_FOR_USERNAME status.

Returns:

the other uuids

See Also:

PlayerSaveResult.Outcome.OTHER_UNIQUE_IDS_PRESENT_FOR_USERNAME