me.lucko.luckperms.api

Interface DemotionResult

All Superinterfaces:

MutateResult

public interface DemotionResult
extends MutateResult

Encapsulates the result of Users demotion along a Track.

Since:

4.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DemotionResult.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
Optional<String>	getGroupFrom() Gets the name of the group the user was demoted from, if applicable.
Optional<String>	getGroupTo() Gets the name of the group the user was demoted from, if applicable.
DemotionResult.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
DemotionResult.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 demoted from, if applicable.

Will only be present for results with a status of DemotionResult.Status.SUCCESS or DemotionResult.Status.REMOVED_FROM_FIRST_GROUP.

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

Returns:

the group the user was demoted from.

getGroupTo

@Nonnull
Optional<String> getGroupTo()

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

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

Returns:

the group the user was demoted to.