Package net.luckperms.api.track

Enum Class PromotionResult.Status

java.lang.Object

java.lang.Enum<PromotionResult.Status>

net.luckperms.api.track.PromotionResult.Status

All Implemented Interfaces:

Serializable, Comparable<PromotionResult.Status>, java.lang.constant.Constable, Result

Enclosing interface:

PromotionResult

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

The result status

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADDED_TO_FIRST_GROUP	Indicates that the user was added to the first group in the track.
AMBIGUOUS_CALL	Indicates that the implementation was unable to determine the users current position on this track.
END_OF_TRACK	Indicates that the user is already a member of the group at the end of the track, and as such cannot be promoted any further.
MALFORMED_TRACK	Indicates that the next group in the track no longer exists.
SUCCESS	Indicates that the user was promoted 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 PromotionResult.Status	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PromotionResult.Status[]	values()	Returns an array containing the constants of this enum class, 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS

public static final PromotionResult.Status SUCCESS

Indicates that the user was promoted normally.

ADDED_TO_FIRST_GROUP

public static final PromotionResult.Status ADDED_TO_FIRST_GROUP

Indicates that the user was added to the first group in the track.

This usually occurs when the user isn't already on any of the groups in the track.

MALFORMED_TRACK

public static final PromotionResult.Status MALFORMED_TRACK

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

END_OF_TRACK

public static final PromotionResult.Status END_OF_TRACK

Indicates that the user is already a member of the group at the end of the track, and as such cannot be promoted any further.

AMBIGUOUS_CALL

public static final PromotionResult.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 PromotionResult.Status UNDEFINED_FAILURE

An undefined failure occurred.

Method Details

values

public static PromotionResult.Status[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PromotionResult.Status valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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