me.lucko.luckperms.api

Class Contexts

java.lang.Object

me.lucko.luckperms.api.Contexts

Direct Known Subclasses:

FullySatisfiedContexts

@Immutable
public class Contexts
extends Object

Encapsulates the options and settings for a permission or meta lookup.

This class is immutable.

Since:

2.11

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVER_KEY The context key used to denote the subjects server
static String	WORLD_KEY The context key used to denote the subjects world

Constructor Summary

Constructors

Constructor and Description
Contexts(ContextSet context, boolean includeGlobal, boolean includeGlobalWorld, boolean applyGroups, boolean applyGlobalGroups, boolean applyGlobalWorldGroups, boolean op)

Method Summary

Modifier and Type	Method and Description
static Contexts	allowAll() Gets the FullySatisfiedContexts instance.
boolean	equals(Object o)
ContextSet	getContexts() Gets the contexts that apply for this lookup
static Contexts	global() A contexts instance with no defined context.
int	hashCode()
boolean	isApplyGlobalGroups() Gets if global or non server specific group memberships should be applied
boolean	isApplyGlobalWorldGroups() Gets if global or non world specific group memberships should be applied
boolean	isApplyGroups() Gets if parent groups should be applied
boolean	isIncludeGlobal() Gets if global or non server specific nodes should be applied
boolean	isIncludeGlobalWorld() Gets if global or non world specific nodes should be applied
boolean	isOp() Gets if the target subject is OP.
static Contexts	of(ContextSet context, boolean includeGlobal, boolean includeGlobalWorld, boolean applyGroups, boolean applyGlobalGroups, boolean applyGlobalWorldGroups, boolean op)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERVER_KEY

public static final String SERVER_KEY

The context key used to denote the subjects server

See Also:

Constant Field Values

WORLD_KEY

public static final String WORLD_KEY

The context key used to denote the subjects world

See Also:

Constant Field Values

Constructor Detail

Contexts

public Contexts(@Nonnull
                ContextSet context,
                boolean includeGlobal,
                boolean includeGlobalWorld,
                boolean applyGroups,
                boolean applyGlobalGroups,
                boolean applyGlobalWorldGroups,
                boolean op)

Method Detail

allowAll

@Nonnull
public static Contexts allowAll()

Gets the FullySatisfiedContexts instance.

Returns:

a context that will satisfy all contextual requirements.

global

@Nonnull
public static Contexts global()

A contexts instance with no defined context.

Returns:

the global contexts

Since:

3.3

of

@Nonnull
public static Contexts of(@Nonnull
                                    ContextSet context,
                                    boolean includeGlobal,
                                    boolean includeGlobalWorld,
                                    boolean applyGroups,
                                    boolean applyGlobalGroups,
                                    boolean applyGlobalWorldGroups,
                                    boolean op)

getContexts

@Nonnull
public ContextSet getContexts()

Gets the contexts that apply for this lookup

Returns:

an immutable set of context key value pairs

Since:

2.13

isOp

public boolean isOp()

Gets if the target subject is OP. This is used to parse defaults on Bukkit, and is ignored on all other platforms.

Returns:

true if op defaults should be included

isIncludeGlobal

public boolean isIncludeGlobal()

Gets if global or non server specific nodes should be applied

Returns:

true if global or non server specific nodes should be applied

isIncludeGlobalWorld

public boolean isIncludeGlobalWorld()

Gets if global or non world specific nodes should be applied

Returns:

true if global or non world specific nodes should be applied

isApplyGroups

public boolean isApplyGroups()

Gets if parent groups should be applied

Returns:

true if parent groups should be applied

isApplyGlobalGroups

public boolean isApplyGlobalGroups()

Gets if global or non server specific group memberships should be applied

Returns:

true if global or non server specific group memberships should be applied

isApplyGlobalWorldGroups

public boolean isApplyGlobalWorldGroups()

Gets if global or non world specific group memberships should be applied

Returns:

true if global or non world specific group memberships should be applied

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object