Package net.luckperms.api.query

Enum Class Flag

java.lang.Object

java.lang.Enum<Flag>

net.luckperms.api.query.Flag

All Implemented Interfaces:

Serializable, Comparable<Flag>, java.lang.constant.Constable

public enum Flag
extends Enum<Flag>

The flags which can be set for a query.

By default (in places like new instances of QueryOptions.Builder and QueryOptions.defaultContextualOptions()), all Flags are set to true.

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
APPLY_INHERITANCE_NODES_WITHOUT_SERVER_CONTEXT	If global or non-server-specific group memberships should be applied
APPLY_INHERITANCE_NODES_WITHOUT_WORLD_CONTEXT	If global or non-world-specific group memberships should be applied
INCLUDE_NODES_WITHOUT_SERVER_CONTEXT	If global or non-server-specific nodes should be applied
INCLUDE_NODES_WITHOUT_WORLD_CONTEXT	If global or non-world-specific nodes should be applied
RESOLVE_INHERITANCE	If parent groups should be resolved

Method Summary

Modifier and Type	Method	Description
static Flag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Flag[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

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

RESOLVE_INHERITANCE

public static final Flag RESOLVE_INHERITANCE

If parent groups should be resolved

INCLUDE_NODES_WITHOUT_SERVER_CONTEXT

public static final Flag INCLUDE_NODES_WITHOUT_SERVER_CONTEXT

If global or non-server-specific nodes should be applied

INCLUDE_NODES_WITHOUT_WORLD_CONTEXT

public static final Flag INCLUDE_NODES_WITHOUT_WORLD_CONTEXT

If global or non-world-specific nodes should be applied

APPLY_INHERITANCE_NODES_WITHOUT_SERVER_CONTEXT

public static final Flag APPLY_INHERITANCE_NODES_WITHOUT_SERVER_CONTEXT

If global or non-server-specific group memberships should be applied

APPLY_INHERITANCE_NODES_WITHOUT_WORLD_CONTEXT

public static final Flag APPLY_INHERITANCE_NODES_WITHOUT_WORLD_CONTEXT

If global or non-world-specific group memberships should be applied

Method Details

values

public static Flag[] 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 Flag 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