Package 

Interface MemoryCache

  • 
public interface MemoryCache

    An interface for adding and removing resources from an in memory cache.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public interface MemoryCache.ResourceRemovedListener

      An interface that will be called whenever a bitmap is removed from the cache.

    • Method Summary

      Modifier and Type Method Description
      abstract long getCurrentSize() Returns the sum of the sizes of all the contents of the cache in bytes.
      abstract long getMaxSize() Returns the current maximum size in bytes of the cache.
      abstract void setSizeMultiplier(float multiplier) Adjust the maximum size of the cache by multiplying the original size of the cache by the givenmultiplier.
      abstract Resource<out Object> remove(@NonNull() Key key) Removes the value for the given key and returns it if present or null otherwise.
      abstract Resource<out Object> put(@NonNull() Key key, @Nullable() Resource<out Object> resource) Add bitmap to the cache with the given key.
      abstract void setResourceRemovedListener(@NonNull() MemoryCache.ResourceRemovedListener listener) Set the listener to be called when a bitmap is removed from the cache.
      abstract void clearMemory() Evict all items from the memory cache.
      abstract void trimMemory(int level) Trim the memory cache to the appropriate level.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getCurrentSize

         abstract long getCurrentSize()

        Returns the sum of the sizes of all the contents of the cache in bytes.

      • getMaxSize

         abstract long getMaxSize()

        Returns the current maximum size in bytes of the cache.

      • setSizeMultiplier

         abstract void setSizeMultiplier(float multiplier)

        Adjust the maximum size of the cache by multiplying the original size of the cache by the givenmultiplier.

        If the size multiplier causes the size of the cache to be decreased, items will be evicteduntil the cache is smaller than the new size.

        Parameters:
        multiplier - A size multiplier >= 0.

      • put

        @Nullable() abstract Resource<out Object> put(@NonNull() Key key, @Nullable() Resource<out Object> resource)

        Add bitmap to the cache with the given key.

        Parameters:
        key - The key to retrieve the bitmap.
        resource - The com.mobwith.imgmodule.load.engine.EngineResource to store.

      • clearMemory

         abstract void clearMemory()

        Evict all items from the memory cache.

      • trimMemory

         abstract void trimMemory(int level)

        Trim the memory cache to the appropriate level. Typically called on the callback onTrimMemory.

        Parameters:
        level - This integer represents a trim level as specified in .