Package net.luckperms.api.context

Enum ContextSatisfyMode

java.lang.Object

java.lang.Enum<ContextSatisfyMode>

net.luckperms.api.context.ContextSatisfyMode

All Implemented Interfaces:

Serializable, Comparable<ContextSatisfyMode>

public enum ContextSatisfyMode
extends Enum<ContextSatisfyMode>

Mode for determining whether a ContextSet satisfies another.

Since:

5.2

See Also:

ContextSet.isSatisfiedBy(ContextSet, ContextSatisfyMode)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_VALUES_PER_KEY	Mode where a ContextSet A will be satisfied by another set B, if all key-value entries in A are also in B.
AT_LEAST_ONE_VALUE_PER_KEY	Mode where a ContextSet A will be satisfied by another set B, if at least one of the key-value entries per key in A are also in B.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ContextSatisfyMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ContextSatisfyMode[]	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

Enum Constant Detail

AT_LEAST_ONE_VALUE_PER_KEY

public static final ContextSatisfyMode AT_LEAST_ONE_VALUE_PER_KEY

Mode where a ContextSet A will be satisfied by another set B, if at least one of the key-value entries per key in A are also in B.

For example, given A = {server=survival, world=overworld, world=nether}, another set X will satisfy A if X contains server=survival AND (world=overworld OR world=nether).

ALL_VALUES_PER_KEY

public static final ContextSatisfyMode ALL_VALUES_PER_KEY

Mode where a ContextSet A will be satisfied by another set B, if all key-value entries in A are also in B.

For example, given A = {server=survival, world=overworld, world=nether}, another set X will satisfy A if X contains server=survival AND world=overworld AND world=nether.

Field Detail

KEY

public static final OptionKey<ContextSatisfyMode> KEY

The OptionKey for ContextSatisfyMode.

Method Detail

values

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

Returns:

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

valueOf

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