Package org.craftercms.core.cache.impl.store

Class NoopCacheStoreAdapter

java.lang.Object
org.craftercms.core.cache.impl.store.NoopCacheStoreAdapter
All Implemented Interfaces:
CacheStoreAdapter
public class NoopCacheStoreAdapter extends Object implements CacheStoreAdapter
Implementation of a CacheStoreAdapter that uses no data structure and whose operations do nothing. Useful in scenarios where you need a cache reference but don't need to cache anything or it's not appropriate, and when testing or troubleshooting.
Author:
Sumer Jabri, Alfonso Vásquez

  • Constructor Details

    • NoopCacheStoreAdapter

      public NoopCacheStoreAdapter()

  • Method Details

    • hasScope

      public boolean hasScope(String scope) throws Exception
      Description copied from interface: CacheStoreAdapter
      Returns true if the specified scope exists in the cache.
      Specified by:
      hasScope in interface CacheStoreAdapter
      Throws:
      Exception

    • getScopes

      public Collection<String> getScopes()
      Description copied from interface: CacheStoreAdapter
      Returns the scopes managed by the underlying store.
      Specified by:
      getScopes in interface CacheStoreAdapter

    • addScope

      public void addScope(String scope, int maxItemsInMemory)
      Description copied from interface: CacheStoreAdapter
      Adds a new scope to the underlying store.
      Specified by:
      addScope in interface CacheStoreAdapter
      Parameters:
      scope - the name of the scope
      maxItemsInMemory - the maximum number of items in memory, before they are evicted

    • removeScope

      public void removeScope(String scope)
      Description copied from interface: CacheStoreAdapter
      Removes an existing scope and all the items that are in it.
      Specified by:
      removeScope in interface CacheStoreAdapter
      Parameters:
      scope - scope to remove

    • getSize

      public int getSize(String scope)
      Description copied from interface: CacheStoreAdapter
      Returns the quantity of items present in the specified scope.
      Specified by:
      getSize in interface CacheStoreAdapter
      Returns:
      the size of the scope (quantity of items)

    • getKeys

      public Collection<Object> getKeys(String scope)
      Description copied from interface: CacheStoreAdapter
      Returns a list of the keys of the items present in the specified scope.
      Specified by:
      getKeys in interface CacheStoreAdapter
      Returns:
      a list of the keys of the available items in the scope

    • hasKey

      public boolean hasKey(String scope, Object key)
      Description copied from interface: CacheStoreAdapter
      Returns true if there's and item with the specified key in the specified scope.
      Specified by:
      hasKey in interface CacheStoreAdapter
      Returns:
      true if the key exists in the scope, false otherwise

    • get

      public CacheItem get(String scope, Object key)
      Description copied from interface: CacheStoreAdapter
      Retrieves an item from a scope.
      Specified by:
      get in interface CacheStoreAdapter
      Parameters:
      scope - scope to get the item from
      key - unique key for the item within this scope
      Returns:
      the requested item if found, null otherwise

    • put

      public void put(CacheItem item)
      Description copied from interface: CacheStoreAdapter
      Puts an item in a scope. The scope is obtained through CacheItem.getScope().
      Specified by:
      put in interface CacheStoreAdapter
      Parameters:
      item - the item to put

    • remove

      public boolean remove(String scope, Object key)
      Description copied from interface: CacheStoreAdapter
      Removes an item from a scope.
      Specified by:
      remove in interface CacheStoreAdapter
      Parameters:
      scope - scope to remove the item from
      key - unique key for the item within this scope
      Returns:
      true if the removal was successful, false otherwise

    • clearAll

      public void clearAll()
      Description copied from interface: CacheStoreAdapter
      Clears the contents of the entire store.
      Specified by:
      clearAll in interface CacheStoreAdapter

    • clearScope

      public void clearScope(String scope)
      Description copied from interface: CacheStoreAdapter
      Clears the contents of the specified scope in the underlying store.
      Specified by:
      clearScope in interface CacheStoreAdapter
      Parameters:
      scope - scope to clear

    • getStatistics

      public CacheStatistics getStatistics(String scope)
      Description copied from interface: CacheStoreAdapter
      Returns the statistics of the specified scope from the underlying store.
      Specified by:
      getStatistics in interface CacheStoreAdapter
      Parameters:
      scope - scope to inspect
      Returns:
      the statistics