Package org.cache2k.operation
Interface CacheOperation
-
- All Known Subinterfaces:
CacheControl
public interface CacheOperation
Commands to influence the cache operation in general.All commands return a
CompletableFuture
. A cache client may choose to wait for the operation to complete or not. As of version 2.0 all operations are completed instantly within the calling thread. This will change in later versions.Outlook: Could get ability to control expiry and refresh behavior, as well as disable the cache.
- Since:
- 2.0
- Author:
- Jens Wilke
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CompletableFuture<Void>
changeCapacity(long entryCountOrWeight)
Change the maximum capacity of the cache.CompletableFuture<Void>
clear()
Clears the cache contents.CompletableFuture<Void>
close()
End cache operations.CompletableFuture<Void>
destroy()
A combination ofCache.clear()
andCache.close()
potentially wiping all stored data of this cache.CompletableFuture<Void>
removeAll()
Removes all cache contents.
-
-
-
Method Detail
-
clear
CompletableFuture<Void> clear()
Clears the cache contents. Identical toCache.clear()
- Returns:
- See class description
-
removeAll
CompletableFuture<Void> removeAll()
Removes all cache contents. This has the same semantics of calling remove to every key, except that the cache is trying to optimize the bulk operation. Same asclear
but listeners will be called.
-
close
CompletableFuture<Void> close()
End cache operations. Identical toCache.close()
- Returns:
- See class description
-
destroy
CompletableFuture<Void> destroy()
A combination ofCache.clear()
andCache.close()
potentially wiping all stored data of this cache.This method is to future proof the API, when a persistence feature is added. In this case the method will stop cache operations and remove all stored external data.
Rationale: The corresponding method in JSR107 is
CacheManager.destroyCache()
.- Returns:
- See class description
-
changeCapacity
CompletableFuture<Void> changeCapacity(long entryCountOrWeight)
Change the maximum capacity of the cache. If a weigher is present this is the maximum weight of all cache entries, otherwise the maximum count of cache entries. The capacity is not allowed to be 0.- Parameters:
entryCountOrWeight
- either maximum number of entries or maximum weight- Returns:
- See class description
- See Also:
Weigher
-
-