org.spongepowered.api.service.context

Interface ContextualService<T extends Contextual>

Type Parameters:

T - the contextual type

All Known Subinterfaces:

EconomyService, PermissionService

public interface ContextualService<T extends Contextual>

A common interface for services which provide a means to store and query data for Contextuals, according to given or calculated Context state.

When functionality is provided to query data based upon a given Set of Contexts, the querying code must consider which of the underlying data is "applicable" to the contexts specified in the query request. It is expected that implementations will deem entries of underlying data to be applicable if the Set of contexts defined in the query contain all of the Contexts required by the data entry. Mathematically, an underlying data entry is "applicable" if [the context of the entry] is a subset of [the context provided in the query], or programmatically if [the context provided in the query] Set.containsAll(Collection) of [the context of the entry].

Method Summary

Modifier and Type	Method and Description
void	registerContextCalculator(ContextCalculator<T> calculator) Registers a ContextCalculator for use by this service.

Method Detail

registerContextCalculator

void registerContextCalculator(ContextCalculator<T> calculator)

Registers a ContextCalculator for use by this service.

It is not guaranteed that the calculator will be used by the service, as some implementations may not support contexts.

Parameters:

calculator - The context calculator to register