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
@NonNull Contexts	formContexts(@NonNull ImmutableContextSet contextSet) Forms a Contexts instance from an ImmutableContextSet.
@NonNull Contexts	formContexts(@NonNull Object subject, @NonNull ImmutableContextSet contextSet) Forms a Contexts instance from an ImmutableContextSet.
@NonNull ImmutableContextSet	getApplicableContext(@NonNull Object subject) Queries the ContextManager for current context values for the subject.
@NonNull Contexts	getApplicableContexts(@NonNull Object subject) Queries the ContextManager for current context values for the subject.
@NonNull ImmutableContextSet	getStaticContext() Gets the contexts from the static calculators in this manager.
@NonNull Contexts	getStaticContexts() Gets the contexts from the static calculators in this manager.
void	invalidateCache(@NonNull Object subject) Invalidates the lookup cache for a given subject
@NonNull Optional<ImmutableContextSet>	lookupApplicableContext(@NonNull User user) Queries the ContextManager for current context values for the given User.
@NonNull Optional<Contexts>	lookupApplicableContexts(@NonNull User user) Queries the ContextManager for current context values for the given User.
void	registerCalculator(@NonNull ContextCalculator<?> calculator) Registers a context calculator with the manager.
void	registerStaticCalculator(@NonNull 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