me.lucko.luckperms.api

Interface PromotionResult

All Superinterfaces:

MutateResult

public interface PromotionResult
extends MutateResult

Encapsulates the result of Users promotion along a Track.

Since:

4.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PromotionResult.Status The result status

Field Summary

Fields inherited from interface me.lucko.luckperms.api.MutateResult

GENERIC_FAILURE, GENERIC_SUCCESS

Method Summary

Modifier and Type	Method and Description
@NonNull Optional<String>	getGroupFrom() Gets the name of the group the user was promoted from, if applicable.
@NonNull Optional<String>	getGroupTo() Gets the name of the group the user was promoted from, if applicable.
@NonNull PromotionResult.Status	getStatus() Gets the status of the result.
default boolean	wasSuccess() Gets if the operation which produced this result completed successfully.

Methods inherited from interface me.lucko.luckperms.api.MutateResult

asBoolean, wasFailure

Method Detail

getStatus

@NonNull PromotionResult.Status getStatus()

Gets the status of the result.

Returns:

the status

wasSuccess

default boolean wasSuccess()

Description copied from interface: MutateResult

Gets if the operation which produced this result completed successfully.

Specified by:

wasSuccess in interface MutateResult

Returns:

if the result indicates a success

getGroupFrom

@NonNull Optional<String> getGroupFrom()

Gets the name of the group the user was promoted from, if applicable.

Will only be present for results with a status of PromotionResult.Status.SUCCESS.

Returns:

the group the user was promoted from.

getGroupTo

@NonNull Optional<String> getGroupTo()

Gets the name of the group the user was promoted from, if applicable.

Will only be present for results with a status of PromotionResult.Status.SUCCESS or PromotionResult.Status.ADDED_TO_FIRST_GROUP.

The value will also be set for results with the PromotionResult.Status.MALFORMED_TRACK status, with this value marking the group which no longer exists.

Returns:

the group the user was promoted to.