me.lucko.luckperms.api.context

Interface ContextManager

public interface ContextManager

Manages ContextCalculators, and calculates applicable contexts for a given type. This interface accepts Object types as a parameter to avoid having to depend on specific server implementations. In all cases, the "player" or "subject" type for the platform must be used. Specifically:

• org.bukkit.entity.Player
• net.md_5.bungee.api.connection.ProxiedPlayer
• org.spongepowered.api.service.permission.Subject

Since:

4.0

Method Summary

Modifier and Type	Method and Description
Contexts	formContexts(ImmutableContextSet contextSet) Forms a Contexts instance from an ImmutableContextSet.
Contexts	formContexts(Object subject, ImmutableContextSet contextSet) Forms a Contexts instance from an ImmutableContextSet.
ImmutableContextSet	getApplicableContext(Object subject) Queries the ContextManager for current context values for the subject.
Contexts	getApplicableContexts(Object subject) Queries the ContextManager for current context values for the subject.
ImmutableContextSet	getStaticContext() Gets the contexts from the static calculators in this manager.
Contexts	getStaticContexts() Gets the contexts from the static calculators in this manager.
void	invalidateCache(Object subject) Invalidates the lookup cache for a given subject
Optional<ImmutableContextSet>	lookupApplicableContext(User user) Queries the ContextManager for current context values for the given User.
Optional<Contexts>	lookupApplicableContexts(User user) Queries the ContextManager for current context values for the given User.
void	registerCalculator(ContextCalculator<?> calculator) Registers a context calculator with the manager.
void	registerStaticCalculator(StaticContextCalculator calculator) Registers a static context calculator with the manager.

Method Detail

getApplicableContext

@Nonnull
ImmutableContextSet getApplicableContext(@Nonnull
                                                   Object subject)

Queries the ContextManager for current context values for the subject.

Parameters:

subject - the subject

Returns:

the applicable context for the subject

getApplicableContexts

@Nonnull
Contexts getApplicableContexts(@Nonnull
                                         Object subject)

Queries the ContextManager for current context values for the subject.

Parameters:

subject - the subject

Returns:

the applicable context for the subject

lookupApplicableContext

@Nonnull
Optional<ImmutableContextSet> lookupApplicableContext(@Nonnull
                                                                User user)

Queries the ContextManager for current context values for the given User.

This will only return a value if the player corresponding to the User is online.

If you need to be a Contexts instance regardless, you should initially try this method, and then fallback on getStaticContext().

Parameters:

user - the user

Returns:

the applicable context for the subject

lookupApplicableContexts

@Nonnull
Optional<Contexts> lookupApplicableContexts(@Nonnull
                                                      User user)

Queries the ContextManager for current context values for the given User.

This will only return a value if the player corresponding to the User is online.

If you need to be a Contexts instance regardless, you should initially try this method, and then fallback on getStaticContexts().

Parameters:

user - the user

Returns:

the applicable context for the subject

getStaticContext

@Nonnull
ImmutableContextSet getStaticContext()

Gets the contexts from the static calculators in this manager.

Static calculators provide the same context for all subjects, and are marked as such when registered.

Returns:

the current active static contexts

getStaticContexts

@Nonnull
Contexts getStaticContexts()

Gets the contexts from the static calculators in this manager.

Static calculators provide the same context for all subjects, and are marked as such when registered.

Returns:

the current active static contexts

formContexts

@Nonnull
Contexts formContexts(@Nonnull
                                Object subject,
                                @Nonnull
                                ImmutableContextSet contextSet)

Forms a Contexts instance from an ImmutableContextSet.

This method relies on the plugins configuration to form the Contexts instance.

Parameters:

subject - the reference subject

contextSet - the context set

Returns:

a contexts instance

formContexts

@Nonnull
Contexts formContexts(@Nonnull
                                ImmutableContextSet contextSet)

Forms a Contexts instance from an ImmutableContextSet.

This method relies on the plugins configuration to form the Contexts instance.

Parameters:

contextSet - the context set

Returns:

a contexts instance

registerCalculator

void registerCalculator(@Nonnull
                        ContextCalculator<?> calculator)

Registers a context calculator with the manager.

Parameters:

calculator - the calculator

registerStaticCalculator

void registerStaticCalculator(@Nonnull
                              StaticContextCalculator calculator)

Registers a static context calculator with the manager.

Static calculators provide the same context for all subjects.

Parameters:

calculator - the calculator

invalidateCache

void invalidateCache(@Nonnull
                     Object subject)

Invalidates the lookup cache for a given subject

Parameters:

subject - the subject