Package net.luckperms.api.track

Enum DemotionResult.Status

java.lang.Object

java.lang.Enum<DemotionResult.Status>

net.luckperms.api.track.DemotionResult.Status

All Implemented Interfaces:

Serializable, Comparable<DemotionResult.Status>, Result

Enclosing interface:

DemotionResult

public static enum DemotionResult.Status
extends Enum<DemotionResult.Status>
implements Result

The result status

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMBIGUOUS_CALL	Indicates that the implementation was unable to determine the users current position on this track.
MALFORMED_TRACK	Indicates that the previous group in the track no longer exists.
NOT_ON_TRACK	Indicates that the user isn't a member of any of the groups on this track.
REMOVED_FROM_FIRST_GROUP	Indicates that the user was removed from the first group in the track.
SUCCESS	Indicates that the user was demoted normally.
UNDEFINED_FAILURE	An undefined failure occurred.

Field Summary

Fields inherited from interface net.luckperms.api.util.Result

GENERIC_FAILURE, GENERIC_SUCCESS

Method Summary

Modifier and Type	Method	Description
static DemotionResult.Status	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DemotionResult.Status[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
boolean	wasSuccessful()	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

Enum Constant Detail

SUCCESS

public static final DemotionResult.Status SUCCESS

Indicates that the user was demoted normally.

REMOVED_FROM_FIRST_GROUP

public static final DemotionResult.Status REMOVED_FROM_FIRST_GROUP

Indicates that the user was removed from the first group in the track.

This usually occurs when the user is currently on the first group, and was demoted "over the start" of the track.

MALFORMED_TRACK

public static final DemotionResult.Status MALFORMED_TRACK

Indicates that the previous group in the track no longer exists.

NOT_ON_TRACK

public static final DemotionResult.Status NOT_ON_TRACK

Indicates that the user isn't a member of any of the groups on this track.

AMBIGUOUS_CALL

public static final DemotionResult.Status AMBIGUOUS_CALL

Indicates that the implementation was unable to determine the users current position on this track.

This usually occurs when the user is on more than one group on the track.

UNDEFINED_FAILURE

public static final DemotionResult.Status UNDEFINED_FAILURE

An undefined failure occurred.

Method Detail

values

public static DemotionResult.Status[] 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 (DemotionResult.Status c : DemotionResult.Status.values())
    System.out.println(c);

Returns:

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

valueOf

public static DemotionResult.Status 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

wasSuccessful

public boolean wasSuccessful()

Description copied from interface: Result

Gets if the operation which produced this result completed successfully.

Specified by:

wasSuccessful in interface Result

Returns:

if the result indicates a success