me.lucko.luckperms.api

Class Contexts

java.lang.Object

me.lucko.luckperms.api.Contexts

Direct Known Subclasses:

FullySatisfiedContexts

public class Contexts
extends Object

Encapsulates the contexts 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

Modifier	Constructor and Description
	Contexts(@NonNull ContextSet contextSet, boolean includeNodesSetWithoutServer, boolean includeNodesSetWithoutWorld, boolean resolveInheritance, boolean applyParentsWithoutServer, boolean applyParentsWithoutWorld, boolean isOp) Deprecated. in favour of of(ContextSet, boolean, boolean, boolean, boolean, boolean, boolean)
protected	Contexts(@NonNull ImmutableContextSet contextSet, byte settingsFlag)

Method Summary

Modifier and Type	Method and Description
static @NonNull Contexts	allowAll() Gets the FullySatisfiedContexts instance.
boolean	equals(Object o)
@NonNull ContextSet	getContexts() Gets the set of context pairs for this Contexts instance.
@NonNull Set<LookupSetting>	getSettings() Gets the set of LookupSettings for this Contexts instance.
static @NonNull Contexts	global() Returns a 'global' or default contexts instance.
int	hashCode()
boolean	hasSetting(@NonNull LookupSetting setting) Gets if the given LookupSetting is set.
boolean	isApplyGlobalGroups() Deprecated. in favour of hasSetting(LookupSetting)
boolean	isApplyGlobalWorldGroups() Deprecated. in favour of hasSetting(LookupSetting)
boolean	isApplyGroups() Deprecated. in favour of hasSetting(LookupSetting)
boolean	isIncludeGlobal() Deprecated. in favour of hasSetting(LookupSetting)
boolean	isIncludeGlobalWorld() Deprecated. in favour of hasSetting(LookupSetting)
boolean	isOp() Deprecated. in favour of hasSetting(LookupSetting)
static @NonNull Contexts	of(@NonNull ContextSet contextSet, boolean includeNodesSetWithoutServer, boolean includeNodesSetWithoutWorld, boolean resolveInheritance, boolean applyParentsWithoutServer, boolean applyParentsWithoutWorld, boolean isOp) Creates a new Contexts instance.
static Contexts	of(@NonNull ContextSet contextSet, @NonNull Set<LookupSetting> settings) Creates a new Contexts instance.
@NonNull Contexts	setContexts(@NonNull ContextSet contextSet) Creates a copy of this Contexts instance, but with the set of context pairs replaced by the given set.
@NonNull Contexts	setSettings(@NonNull Set<LookupSetting> settings) Creates a copy of this Contexts instance, but with the LookupSettings replaced by the given settings.
@NonNull 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

@Deprecated
public Contexts(@NonNull ContextSet contextSet,
                            boolean includeNodesSetWithoutServer,
                            boolean includeNodesSetWithoutWorld,
                            boolean resolveInheritance,
                            boolean applyParentsWithoutServer,
                            boolean applyParentsWithoutWorld,
                            boolean isOp)

Deprecated. in favour of of(ContextSet, boolean, boolean, boolean, boolean, boolean, boolean)

Creates a new Contexts instance.

Parameters:

contextSet - the context set

includeNodesSetWithoutServer - the value of LookupSetting.INCLUDE_NODES_SET_WITHOUT_SERVER

includeNodesSetWithoutWorld - the value of LookupSetting.INCLUDE_NODES_SET_WITHOUT_WORLD

resolveInheritance - the value of LookupSetting.RESOLVE_INHERITANCE

applyParentsWithoutServer - the value of LookupSetting.APPLY_PARENTS_SET_WITHOUT_SERVER

applyParentsWithoutWorld - the value of LookupSetting.APPLY_PARENTS_SET_WITHOUT_WORLD

isOp - the value of LookupSetting.IS_OP

Contexts

protected Contexts(@NonNull ImmutableContextSet contextSet,
                   byte settingsFlag)

Method Detail

allowAll

public static @NonNull Contexts allowAll()

Gets the FullySatisfiedContexts instance.

Returns:

a context that will satisfy all contextual requirements.

global

public static @NonNull Contexts global()

Returns a 'global' or default contexts instance.

Formed of an empty ContextSet and all inclusion and inheritance LookupSettings applied.

Returns:

the global contexts

Since:

3.3

of

public static @NonNull Contexts of(@NonNull ContextSet contextSet,
                                   boolean includeNodesSetWithoutServer,
                                   boolean includeNodesSetWithoutWorld,
                                   boolean resolveInheritance,
                                   boolean applyParentsWithoutServer,
                                   boolean applyParentsWithoutWorld,
                                   boolean isOp)

Creates a new Contexts instance.

Parameters:

contextSet - the context set

includeNodesSetWithoutServer - the value of LookupSetting.INCLUDE_NODES_SET_WITHOUT_SERVER

includeNodesSetWithoutWorld - the value of LookupSetting.INCLUDE_NODES_SET_WITHOUT_WORLD

resolveInheritance - the value of LookupSetting.RESOLVE_INHERITANCE

applyParentsWithoutServer - the value of LookupSetting.APPLY_PARENTS_SET_WITHOUT_SERVER

applyParentsWithoutWorld - the value of LookupSetting.APPLY_PARENTS_SET_WITHOUT_WORLD

isOp - the value of LookupSetting.IS_OP

Returns:

a new instance

of

public static Contexts of(@NonNull ContextSet contextSet,
                          @NonNull Set<LookupSetting> settings)

Creates a new Contexts instance.

Parameters:

contextSet - the context set

settings - the settings

Returns:

a new instance

getContexts

public @NonNull ContextSet getContexts()

Gets the set of context pairs for this Contexts instance.

Returns:

an immutable context from this instance

Since:

2.13

getSettings

public @NonNull Set<LookupSetting> getSettings()

Gets the set of LookupSettings for this Contexts instance.

Returns:

the settings

Since:

4.2

setContexts

public @NonNull Contexts setContexts(@NonNull ContextSet contextSet)

Creates a copy of this Contexts instance, but with the set of context pairs replaced by the given set.

Parameters:

contextSet - the context set

Returns:

a new contexts instance representing the new settings

Since:

4.4

setSettings

public @NonNull Contexts setSettings(@NonNull Set<LookupSetting> settings)

Creates a copy of this Contexts instance, but with the LookupSettings replaced by the given settings.

Parameters:

settings - the lookup settings

Returns:

a new contexts instance representing the new settings

Since:

4.4

hasSetting

public boolean hasSetting(@NonNull LookupSetting setting)

Gets if the given LookupSetting is set.

Parameters:

setting - the setting

Returns:

the value

Since:

4.2

isOp

@Deprecated
public boolean isOp()

Deprecated. in favour of hasSetting(LookupSetting)

Gets the value of LookupSetting.IS_OP.

Returns:

the value

See Also:

LookupSetting.IS_OP

isIncludeGlobal

@Deprecated
public boolean isIncludeGlobal()

Deprecated. in favour of hasSetting(LookupSetting)

Gets the value of LookupSetting.INCLUDE_NODES_SET_WITHOUT_SERVER.

Returns:

the value

See Also:

LookupSetting.INCLUDE_NODES_SET_WITHOUT_SERVER

isIncludeGlobalWorld

@Deprecated
public boolean isIncludeGlobalWorld()

Deprecated. in favour of hasSetting(LookupSetting)

Gets the value of LookupSetting.INCLUDE_NODES_SET_WITHOUT_WORLD.

Returns:

the value

See Also:

LookupSetting.INCLUDE_NODES_SET_WITHOUT_WORLD

isApplyGroups

@Deprecated
public boolean isApplyGroups()

Deprecated. in favour of hasSetting(LookupSetting)

Gets the value of LookupSetting.RESOLVE_INHERITANCE.

Returns:

the value

See Also:

LookupSetting.RESOLVE_INHERITANCE

isApplyGlobalGroups

@Deprecated
public boolean isApplyGlobalGroups()

Deprecated. in favour of hasSetting(LookupSetting)

Gets the value of LookupSetting.APPLY_PARENTS_SET_WITHOUT_SERVER.

Returns:

the value

See Also:

LookupSetting.APPLY_PARENTS_SET_WITHOUT_SERVER

isApplyGlobalWorldGroups

@Deprecated
public boolean isApplyGlobalWorldGroups()

Deprecated. in favour of hasSetting(LookupSetting)

Gets the value of LookupSetting.APPLY_PARENTS_SET_WITHOUT_WORLD.

Returns:

the value

See Also:

LookupSetting.APPLY_PARENTS_SET_WITHOUT_WORLD

toString

public @NonNull 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