public interface CachedData
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.
For meta, both methods accepting Contexts and MetaContexts
are provided. The only difference is that the latter allows you to define
how the meta stack should be structured internally. Where Contexts
are passed, the values from the configuration are used.
| Modifier and Type | Method and Description |
|---|---|
@NonNull MetaData |
calculateMeta(@NonNull Contexts contexts)
Calculates meta data, bypassing the cache.
|
@NonNull MetaData |
calculateMeta(@NonNull MetaContexts contexts)
Calculates meta data, bypassing the cache.
|
@NonNull PermissionData |
calculatePermissions(@NonNull Contexts contexts)
Calculates permission data, bypassing the cache.
|
@NonNull MetaData |
getMetaData(@NonNull Contexts contexts)
Gets MetaData from the cache, given a specified context.
|
@NonNull MetaData |
getMetaData(@NonNull MetaContexts contexts)
Gets MetaData from the cache, given a specified context.
|
@NonNull PermissionData |
getPermissionData(@NonNull Contexts contexts)
Gets PermissionData from the cache, given a specified context.
|
void |
invalidateMeta()
Invalidates all cached
MetaData instances. |
void |
invalidateMeta(@NonNull Contexts contexts)
|
void |
invalidateMeta(@NonNull MetaContexts contexts)
Invalidates any cached
MetaData instances mapped to the given
MetaContexts. |
void |
invalidatePermissionCalculators()
Invalidates all of the underlying Permission calculators.
|
void |
invalidatePermissions()
Invalidates all cached
PermissionData instances. |
void |
invalidatePermissions(@NonNull Contexts contexts)
Invalidates any cached
PermissionData instances mapped to the given
Contexts. |
default void |
preCalculate(@NonNull Contexts contexts)
Pre-calculates and caches
PermissionData and MetaData
instances for a given context. |
default void |
preCalculate(@NonNull Set<Contexts> contexts)
Pre-calculates and caches
PermissionData and MetaData
instances for the given contexts. |
void |
recalculateMeta()
Recalculates meta data for all known contexts.
|
void |
recalculateMeta(@NonNull Contexts contexts)
(Re)calculates meta data for a given context.
|
void |
recalculateMeta(@NonNull MetaContexts contexts)
(Re)calculates meta data for a given context.
|
void |
recalculatePermissions()
Recalculates permission data for all known contexts.
|
void |
recalculatePermissions(@NonNull Contexts contexts)
(Re)calculates permission data for a given context.
|
@NonNull CompletableFuture<Void> |
reloadMeta()
Reloads meta data for all known contexts.
|
@NonNull CompletableFuture<? extends MetaData> |
reloadMeta(@NonNull Contexts contexts)
(Re)loads meta data for a given context.
|
@NonNull CompletableFuture<? extends MetaData> |
reloadMeta(@NonNull MetaContexts contexts)
(Re)loads meta data for a given context.
|
@NonNull CompletableFuture<Void> |
reloadPermissions()
Reloads permission data for all known contexts.
|
@NonNull CompletableFuture<? extends PermissionData> |
reloadPermissions(@NonNull Contexts contexts)
(Re)loads permission data for a given context.
|
@NonNull PermissionData getPermissionData(@NonNull Contexts contexts)
contexts - the contexts to get the permission data inNullPointerException - if contexts is null@NonNull MetaData getMetaData(@NonNull MetaContexts contexts)
contexts - the contexts to get the permission data inNullPointerException - if contexts is null@NonNull MetaData getMetaData(@NonNull Contexts contexts)
contexts - the contexts to get the permission data inNullPointerException - if contexts is null@NonNull PermissionData calculatePermissions(@NonNull Contexts contexts)
The result of this operation is calculated each time the method is called. The result is not added to the internal cache.
It is therefore highly recommended to use getPermissionData(Contexts) instead.
The use cases of this method are more around constructing one-time
instances of PermissionData, without adding the result to the cache.
contexts - the contexts to get permission data inNullPointerException - if contexts is null@NonNull MetaData calculateMeta(@NonNull MetaContexts contexts)
The result of this operation is calculated each time the method is called. The result is not added to the internal cache.
It is therefore highly recommended to use getMetaData(MetaContexts) instead.
The use cases of this method are more around constructing one-time
instances of MetaData, without adding the result to the cache.
contexts - the contexts to get meta data inNullPointerException - if contexts is null@NonNull MetaData calculateMeta(@NonNull Contexts contexts)
The result of this operation is calculated each time the method is called. The result is not added to the internal cache.
It is therefore highly recommended to use getMetaData(Contexts) instead.
The use cases of this method are more around constructing one-time
instances of MetaData, without adding the result to the cache.
contexts - the contexts to get meta data inNullPointerException - if contexts is nullvoid recalculatePermissions(@NonNull Contexts contexts)
This method returns immediately in all cases. The (re)calculation is performed asynchronously and applied to the cache in the background.
If there was a previous PermissionData instance associated with
the given Contexts, then that instance will continue to be returned by
getPermissionData(Contexts) until the recalculation is completed.
If there was no value calculated and cached prior to the call of this method, then one will be calculated.
contexts - the contexts to recalculate in.NullPointerException - if contexts is nullvoid recalculateMeta(@NonNull MetaContexts contexts)
This method returns immediately in all cases. The (re)calculation is performed asynchronously and applied to the cache in the background.
If there was a previous MetaData instance associated with
the given MetaContexts, then that instance will continue to be returned by
getMetaData(MetaContexts) until the recalculation is completed.
If there was no value calculated and cached prior to the call of this method, then one will be calculated.
contexts - the contexts to recalculate in.NullPointerException - if contexts is nullvoid recalculateMeta(@NonNull Contexts contexts)
This method returns immediately in all cases. The (re)calculation is performed asynchronously and applied to the cache in the background.
If there was a previous MetaData instance associated with
the given Contexts, then that instance will continue to be returned by
getMetaData(Contexts) until the recalculation is completed.
If there was no value calculated and cached prior to the call of this method, then one will be calculated.
contexts - the contexts to recalculate in.NullPointerException - if contexts is null@NonNull CompletableFuture<? extends PermissionData> reloadPermissions(@NonNull Contexts contexts)
Unlike recalculatePermissions(Contexts), this method immediately
invalidates any previous PermissionData values contained within the cache,
and then schedules a task to reload a new PermissionData instance to
replace the one which was invalidated.
The invalidation happens immediately during the execution of this method. The result of the re-computation encapsulated by the future.
Subsequent calls to getPermissionData(Contexts) will block until
the result of this operation is complete.
If there was no value calculated and cached prior to the call of this method, then one will be calculated.
This method returns a Future so users can optionally choose to wait until the recalculation has been performed.
contexts - the contexts to reload in.NullPointerException - if contexts is null@NonNull CompletableFuture<? extends MetaData> reloadMeta(@NonNull MetaContexts contexts)
Unlike recalculateMeta(MetaContexts), this method immediately
invalidates any previous MetaData values contained within the cache,
and then schedules a task to reload a new MetaData instance to
replace the one which was invalidated.
The invalidation happens immediately during the execution of this method. The result of the re-computation encapsulated by the future.
Subsequent calls to getMetaData(MetaContexts) will block until
the result of this operation is complete.
If there was no value calculated and cached prior to the call of this method, then one will be calculated.
This method returns a Future so users can optionally choose to wait until the recalculation has been performed.
contexts - the contexts to reload in.NullPointerException - if contexts is null@NonNull CompletableFuture<? extends MetaData> reloadMeta(@NonNull Contexts contexts)
Unlike recalculateMeta(Contexts), this method immediately
invalidates any previous MetaData values contained within the cache,
and then schedules a task to reload a new MetaData instance to
replace the one which was invalidated.
The invalidation happens immediately during the execution of this method. The result of the re-computation encapsulated by the future.
Subsequent calls to getMetaData(Contexts) will block until
the result of this operation is complete.
If there was no value calculated and cached prior to the call of this method, then one will be calculated.
This method returns a Future so users can optionally choose to wait until the recalculation has been performed.
contexts - the contexts to reload in.NullPointerException - if contexts is nullvoid recalculatePermissions()
This method returns immediately. The recalculation is performed asynchronously and applied to the cache in the background.
The previous PermissionData instances will continue to be returned
by getPermissionData(Contexts) until the recalculation is completed.
void recalculateMeta()
This method returns immediately. The recalculation is performed asynchronously and applied to the cache in the background.
The previous MetaData instances will continue to be returned
by getMetaData(MetaContexts) and getMetaData(Contexts)
until the recalculation is completed.
@NonNull CompletableFuture<Void> reloadPermissions()
Unlike recalculatePermissions(), this method immediately
invalidates all previous PermissionData values contained within the cache,
and then schedules a task to reload a new PermissionData instances to
replace the ones which were invalidated.
The invalidation happens immediately during the execution of this method. The result of the re-computation encapsulated by the future.
Subsequent calls to getPermissionData(Contexts) will block until
the result of this operation is complete.
This method returns a Future so users can optionally choose to wait until the recalculation has been performed.
@NonNull CompletableFuture<Void> reloadMeta()
Unlike recalculateMeta(), this method immediately
invalidates all previous MetaData values contained within the cache,
and then schedules a task to reload a new MetaData instances to
replace the ones which were invalidated.
The invalidation happens immediately during the execution of this method. The result of the re-computation encapsulated by the future.
Subsequent calls to getMetaData(MetaContexts) and
getMetaData(Contexts) will block until the result of this operation
is complete.
This method returns a Future so users can optionally choose to wait until the recalculation has been performed.
default void preCalculate(@NonNull Set<Contexts> contexts)
PermissionData and MetaData
instances for the given contexts.
If the cache already contains a value for the given context, no action is taken.
This method blocks until the calculation is completed.
contexts - a set of contextsNullPointerException - if contexts is nulldefault void preCalculate(@NonNull Contexts contexts)
PermissionData and MetaData
instances for a given context.
If the cache already contains a value for the given context, no action is taken.
This method blocks until the calculation is completed.
contexts - the contexts to pre-calculate forNullPointerException - if contexts is nullvoid invalidatePermissions(@NonNull Contexts contexts)
PermissionData instances mapped to the given
Contexts.contexts - the contexts to invalidate forvoid invalidateMeta(@NonNull MetaContexts contexts)
MetaData instances mapped to the given
MetaContexts.contexts - the contexts to invalidate forvoid invalidateMeta(@NonNull Contexts contexts)
contexts - the contexts to invalidate forvoid invalidatePermissions()
PermissionData instances.void invalidateMeta()
MetaData instances.void invalidatePermissionCalculators()
Can be called to allow for an update in defaults.