me.lucko.luckperms.api

Interface MutateResult

All Known Subinterfaces:

DemotionResult, PromotionResult

All Known Implementing Classes:

DataMutateResult, DemotionResult.Status, PromotionResult.Status

public interface MutateResult

Represents the result to a "mutation" on an object.

Since:

4.2

Field Summary

Fields

Modifier and Type	Field and Description
static MutateResult	GENERIC_FAILURE Instance of MutateResult which always reports failure.
static MutateResult	GENERIC_SUCCESS Instance of MutateResult which always reports success.

Method Summary

Modifier and Type	Method and Description
default boolean	asBoolean() Gets a boolean representation of the result.
default boolean	wasFailure() Gets if the operation which produced this result failed.
boolean	wasSuccess() Gets if the operation which produced this result completed successfully.

Field Detail

GENERIC_SUCCESS

static final MutateResult GENERIC_SUCCESS

Instance of MutateResult which always reports success.

GENERIC_FAILURE

static final MutateResult GENERIC_FAILURE

Instance of MutateResult which always reports failure.

Method Detail

wasSuccess

boolean wasSuccess()

Gets if the operation which produced this result completed successfully.

Returns:

if the result indicates a success

wasFailure

default boolean wasFailure()

Gets if the operation which produced this result failed.

Returns:

if the result indicates a failure

asBoolean

default boolean asBoolean()

Gets a boolean representation of the result.

A value of true marks that the operation was a success and a value of false marks that the operation was a failure.

Returns:

a boolean representation