Package io.micronaut.cache.noop

Class NoOpSyncCache

java.lang.Object
io.micronaut.cache.noop.NoOpSyncCache
All Implemented Interfaces:
Cache<Object>, SyncCache<Object>
public class NoOpSyncCache extends Object implements SyncCache<Object>
A no operation SyncCache implementation suitable for disabling caching.
Since:
1.0.0
Author:
Marcel Overdijk

  • Constructor Details

    • NoOpSyncCache

      public NoOpSyncCache(String name)
      Constructor.
      Parameters:
      name - the cache name

  • Method Details

    • get

      @NonNull public <T> @NonNull Optional<T> get(@NonNull @NonNull Object key, @NonNull @NonNull io.micronaut.core.type.Argument<T> requiredType)
      Description copied from interface: SyncCache
      Resolve the given value for the given key.
      Specified by:
      get in interface SyncCache<Object>
      Type Parameters:
      T - The concrete type
      Parameters:
      key - The cache key
      requiredType - The required type
      Returns:
      An optional containing the value if it exists and is able to be converted to the specified type

    • get

      public <T> T get(@NonNull @NonNull Object key, @NonNull @NonNull io.micronaut.core.type.Argument<T> requiredType, @NonNull @NonNull Supplier<T> supplier)
      Description copied from interface: SyncCache
      Resolve the given value for the given key. If the value is not found the specified Supplier will be invoked and the return value cached.
      Specified by:
      get in interface SyncCache<Object>
      Type Parameters:
      T - The concrete type
      Parameters:
      key - The cache key
      requiredType - The required type
      supplier - The supplier that should be invoked if the value is not found
      Returns:
      An optional containing the value if it exists and is able to be converted to the specified type

    • putIfAbsent

      @NonNull public <T> @NonNull Optional<T> putIfAbsent(@NonNull @NonNull Object key, @NonNull T value)
      Description copied from interface: SyncCache

      Cache the specified value using the specified key if it is not already present.

      Specified by:
      putIfAbsent in interface SyncCache<Object>
      Type Parameters:
      T - The concrete type
      Parameters:
      key - the key with which the specified value is to be associated
      value - the value to be associated with the specified key
      Returns:
      An optional of the existing value or Optional.empty() if the specified value parameter was cached

    • put

      public void put(@NonNull @NonNull Object key, @NonNull @NonNull Object value)
      Description copied from interface: SyncCache

      Cache the specified value using the specified key.

      Specified by:
      put in interface SyncCache<Object>
      Parameters:
      key - the key with which the specified value is to be associated
      value - the value to be associated with the specified key

    • invalidate

      public void invalidate(@NonNull @NonNull Object key)
      Description copied from interface: SyncCache
      Invalidate the value for the given key.
      Specified by:
      invalidate in interface SyncCache<Object>
      Parameters:
      key - The key to invalid

    • invalidateAll

      public void invalidateAll()
      Description copied from interface: SyncCache
      Invalidate all cached values within this cache.
      Specified by:
      invalidateAll in interface SyncCache<Object>

    • getName

      public String getName()
      Specified by:
      getName in interface Cache<Object>
      Returns:
      The name of the cache

    • getNativeCache

      public Object getNativeCache()
      Specified by:
      getNativeCache in interface Cache<Object>
      Returns:
      The native cache implementation