net.luckperms.api.query.dataorder

Interface DataQueryOrderFunction

public interface DataQueryOrderFunction

A function that generates a DataQueryOrder comparator for PermissionHolders as required during inheritance.

Field Summary

Fields

Modifier and Type	Field and Description
static OptionKey<DataQueryOrderFunction>	KEY The OptionKey for DataQueryOrderFunction.

Method Summary

Modifier and Type	Method and Description
static DataQueryOrderFunction	always(Comparator<DataType> comparator) Creates a DataQueryOrderFunction that always returns the given comparator.
@NonNull Comparator<DataType>	getOrderComparator(PermissionHolder.Identifier holderIdentifier) Gets the DataQueryOrder comparator for the given holder identifier.

Field Detail

KEY

static final OptionKey<DataQueryOrderFunction> KEY

The OptionKey for DataQueryOrderFunction.

Method Detail

always

static DataQueryOrderFunction always(Comparator<DataType> comparator)

Creates a DataQueryOrderFunction that always returns the given comparator.

Parameters:

comparator - the comparator

Returns:

the data query order function

Since:

5.2

getOrderComparator

@NonNull Comparator<DataType> getOrderComparator(PermissionHolder.Identifier holderIdentifier)

Gets the DataQueryOrder comparator for the given holder identifier.

Parameters:

holderIdentifier - the holder identifier

Returns:

the comparator to use