Package com.gentlyweb.utils
Interface MultipleObjectCacheManager
public interface MultipleObjectCacheManager
This interface should be implemented by classes that contain X number of publicly available
ObjectCaches, it provides methods that allow applications to control the caches without
understanding what is inside the cache.
All of the methods in this interface are optional and if not supported then implementing classes should throw
This interface mirrors
All of the methods in this interface are optional and if not supported then implementing classes should throw
UnsupportedOperationException
.
This interface mirrors
ObjectCacheManager
but each method (where appropriate)
takes a key object to tell the implementing class which cache it wants the operation
to occur on.-
Method Summary
Modifier and TypeMethodDescriptionint
Return the current capacity of the cache, it should basically be (max size - current size).void
Let the object cache be flushed.boolean
Return whether the cache is empty or not.void
merge
(Object key, ObjectCache cache) Merge the current cache with another.void
Add all the entries in the Map to cache.void
Resize the cache to a particular size, if the size is actually bigger than the current size then this operation should not touch the cached objects, if the size is less then the cache should be reduced in size using the current policy until the size is reached.void
setMaxSize
(Object key, int size) Set the maximum size of the cache.void
Set the policy for managing the cache, should be one of:invalid reference
ObjectCache.OLDEST
invalid reference
ObjectCache.YOUNGEST
invalid reference
ObjectCache.RANDOM
void
Get all the entries in the cache as a Map of key to value.
-
Method Details
-
flush
Let the object cache be flushed.- Parameters:
key
- The key to identify the particular cache.
-
setMaxSize
Set the maximum size of the cache.- Parameters:
key
- The key to identify the particular cache.size
- The maximum size.
-
resize
Resize the cache to a particular size, if the size is actually bigger than the current size then this operation should not touch the cached objects, if the size is less then the cache should be reduced in size using the current policy until the size is reached. Either way the maximum size should be set to this value.- Parameters:
key
- The key to identify the particular cache.size
- The new size.
-
capacity
Return the current capacity of the cache, it should basically be (max size - current size).- Parameters:
key
- The key to identify the particular cache.- Returns:
- The current number of items that can be added until the cache reaches it's maximum size.
-
isEmpty
Return whether the cache is empty or not.- Parameters:
key
- The key to identify the particular cache.- Returns:
true
if the cache is empty,false
if it has entries.
-
toMap
Get all the entries in the cache as a Map of key to value.- Parameters:
map
- The Map that should be populated with the key/values in the cache.key
- The key to identify the particular cache.
-
merge
Merge the current cache with another.- Parameters:
key
- The key to identify the particular cache.cache
- The cache to merge.
-
putAll
Add all the entries in the Map to cache.- Parameters:
key
- The key to identify the particular cache.map
- The Map to get key/values from.
-
setPolicy
Set the policy for managing the cache, should be one of:invalid reference
ObjectCache.OLDEST
invalid reference
ObjectCache.YOUNGEST
invalid reference
ObjectCache.RANDOM
- Parameters:
key
- The key to identify the particular cache.policy
- The policy.
-