net.luckperms.api.cacheddata

Interface CachedDataManager

public interface CachedDataManager

Holds cached permission and meta lookup data for a PermissionHolder.

All calls will account for inheritance, as well as any default data provided by the platform. This calls are heavily cached and are therefore fast.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CachedDataManager.Container<T extends CachedData> Manages a specific type of cached data within a CachedDataManager instance.

Method Summary

Modifier and Type	Method and Description
@NonNull CachedMetaData	getMetaData() Gets MetaData from the cache, using the most appropriate query options available at the time.
@NonNull CachedMetaData	getMetaData(@NonNull QueryOptions queryOptions) Gets MetaData from the cache, using the given query options.
@NonNull CachedPermissionData	getPermissionData() Gets PermissionData from the cache, using the most appropriate query options available at the time.
@NonNull CachedPermissionData	getPermissionData(@NonNull QueryOptions queryOptions) Gets PermissionData from the cache, using the given query options.
void	invalidate() Invalidates all cached CachedPermissionData and CachedMetaData instances.
void	invalidatePermissionCalculators() Invalidates all of the underlying Permission calculators.
@NonNull CachedDataManager.Container<CachedMetaData>	metaData() Gets the manager for CachedMetaData.
@NonNull CachedDataManager.Container<CachedPermissionData>	permissionData() Gets the manager for CachedPermissionData.

Method Detail

permissionData

@NonNull CachedDataManager.Container<CachedPermissionData> permissionData()

Gets the manager for CachedPermissionData.

Returns:

the permission data manager

metaData

@NonNull CachedDataManager.Container<CachedMetaData> metaData()

Gets the manager for CachedMetaData.

Returns:

the meta data manager

getPermissionData

@NonNull CachedPermissionData getPermissionData(@NonNull QueryOptions queryOptions)

Gets PermissionData from the cache, using the given query options.

Parameters:

queryOptions - the query options

Returns:

a permission data instance

getMetaData

@NonNull CachedMetaData getMetaData(@NonNull QueryOptions queryOptions)

Gets MetaData from the cache, using the given query options.

Parameters:

queryOptions - the query options

Returns:

a meta data instance

getPermissionData

@NonNull CachedPermissionData getPermissionData()

Gets PermissionData from the cache, using the most appropriate query options available at the time.

For Users, the most appropriate query options will be their current active query options if the corresponding player is online, and otherwise, will fallback to the current static query options if they are offline.

For Groups, the most appropriate query options will always be ContextManager.getStaticQueryOptions() the current static query options.

Returns:

a permission data instance

Since:

5.1

getMetaData

@NonNull CachedMetaData getMetaData()

Gets MetaData from the cache, using the most appropriate query options available at the time.

For Users, the most appropriate query options will be their current active query options if the corresponding player is online, and otherwise, will fallback to the current static query options if they are offline.

For Groups, the most appropriate query options will always be ContextManager.getStaticQueryOptions() the current static query options.

Returns:

a meta data instance

Since:

5.1

See Also:

PermissionHolder.getQueryOptions()

invalidate

void invalidate()

Invalidates all cached CachedPermissionData and CachedMetaData instances.

invalidatePermissionCalculators

void invalidatePermissionCalculators()

Invalidates all of the underlying Permission calculators.

Can be called to allow for an update in defaults.