me.lucko.luckperms.api

Enum DataMutateResult

java.lang.Object

java.lang.Enum<DataMutateResult>

me.lucko.luckperms.api.DataMutateResult

All Implemented Interfaces:

Serializable, Comparable<DataMutateResult>, MutateResult

public enum DataMutateResult
extends Enum<DataMutateResult>
implements MutateResult

Represents the result of a data mutation call on a LuckPerms object.

Usually as the result to a call on a PermissionHolder or Track.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_HAS Indicates the mutation failed because the subject of the action already has something
FAIL Indicates the mutation failed
LACKS Indicates the mutation failed because the subject of the action lacks something
SUCCESS Indicates the mutation was a success

Field Summary

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

GENERIC_FAILURE, GENERIC_SUCCESS

Method Summary

Modifier and Type	Method and Description
static DataMutateResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataMutateResult[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
boolean	wasSuccess() Gets if the operation which produced this result completed successfully.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

asBoolean, wasFailure

Enum Constant Detail

SUCCESS

public static final DataMutateResult SUCCESS

Indicates the mutation was a success

ALREADY_HAS

public static final DataMutateResult ALREADY_HAS

Indicates the mutation failed because the subject of the action already has something

LACKS

public static final DataMutateResult LACKS

Indicates the mutation failed because the subject of the action lacks something

FAIL

public static final DataMutateResult FAIL

Indicates the mutation failed

Method Detail

values

public static DataMutateResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DataMutateResult c : DataMutateResult.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataMutateResult valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

wasSuccess

public 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