net.luckperms.api.query.dataorder

Enum DataQueryOrder

java.lang.Object

java.lang.Enum<DataQueryOrder>

net.luckperms.api.query.dataorder.DataQueryOrder

All Implemented Interfaces:

Serializable, Comparable<DataQueryOrder>, Comparator<DataType>

public enum DataQueryOrder
extends Enum<DataQueryOrder>
implements Comparator<DataType>

Represents the order in which to query different DataTypes.

The DataQueryOrder enum simply represents some default implementations of the Comparator required by QueryOptions and the queryInOrder(Comparator, Consumer) or order(Comparator) methods.

Users are free to implement their own comparator. However, be aware that it is possible that more DataTypes may be added in the future. Ideally the Comparator implementations should be able to handle these smoothly.

See Also:

DataQueryOrderFunction

Enum Constant Summary

Enum Constants

Enum Constant and Description
TRANSIENT_FIRST A data query order indicating that DataType.TRANSIENT should be queried first.
TRANSIENT_LAST A data query order indicating that DataType.TRANSIENT should be queried last.

Method Summary

Modifier and Type	Method and Description
static List<DataType>	order(@NonNull Comparator<? super DataType> comparator) Gets a List of all DataTypes, in order of greatest to least, as defined by the comparator.
static void	queryInOrder(@NonNull Comparator<? super DataType> comparator, @NonNull Consumer<? super DataType> action) Calls the action Consumer for each DataType, in the order defined by the comparator.
static DataQueryOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataQueryOrder[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

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 java.util.Comparator

compare, comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Enum Constant Detail

TRANSIENT_FIRST

public static final DataQueryOrder TRANSIENT_FIRST

A data query order indicating that DataType.TRANSIENT should be queried first.

TRANSIENT_LAST

public static final DataQueryOrder TRANSIENT_LAST

A data query order indicating that DataType.TRANSIENT should be queried last.

Method Detail

values

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

Returns:

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

valueOf

public static DataQueryOrder 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

order

public static List<DataType> order(@NonNull Comparator<? super DataType> comparator)

Gets a List of all DataTypes, in order of greatest to least, as defined by the comparator.

Equivalent to calling Arrays.sort(Object[], Comparator) on DataType.values(), but with the comparator reversed.

Parameters:

comparator - the comparator

Returns:

the ordered data types

queryInOrder

public static void queryInOrder(@NonNull Comparator<? super DataType> comparator,
                                @NonNull Consumer<? super DataType> action)

Calls the action Consumer for each DataType, in the order defined by the comparator.

Parameters:

comparator - the comparator

action - the action