public interface

CacheKeyFactory

com.facebook.imagepipeline.cache.CacheKeyFactory
Known Indirect Subclasses

Class Overview

Factory methods for creating cache keys for the pipeline.

Summary

Public Methods
abstract CacheKey getBitmapCacheKey(ImageRequest request, Object callerContext)
abstract CacheKey getEncodedCacheKey(ImageRequest request, Object callerContext)
Creates a key to be used in the encoded memory and disk caches.
abstract CacheKey getEncodedCacheKey(ImageRequest request, Uri sourceUri, Object callerContext)
Creates a key to be used in the encoded memory and disk caches.
abstract CacheKey getPostprocessedBitmapCacheKey(ImageRequest request, Object callerContext)

Public Methods

public abstract CacheKey getBitmapCacheKey (ImageRequest request, Object callerContext)

Returns
  • CacheKey for doing bitmap cache lookups in the pipeline.

public abstract CacheKey getEncodedCacheKey (ImageRequest request, Object callerContext)

Creates a key to be used in the encoded memory and disk caches.

Implementations must return consistent values for the same request or else caches will not work efficiently.

Parameters
request the image request to be cached or queried from cache
callerContext included for optional debugging or logging purposes only
Returns
  • CacheKey for doing encoded image lookups in the pipeline.

public abstract CacheKey getEncodedCacheKey (ImageRequest request, Uri sourceUri, Object callerContext)

Creates a key to be used in the encoded memory and disk caches.

This version of the method receives a specific URI which may differ from the one held by the request (in cases such as when using MediaVariations). You should not consider the URI in the request.

Implementations must return consistent values for the same request or else caches will not work efficiently.

Parameters
request the image request to be cached or queried from cache
sourceUri the URI to use for the key, which may override the one held in the request
callerContext included for optional debugging or logging purposes only
Returns
  • CacheKey for doing encoded image lookups in the pipeline.

public abstract CacheKey getPostprocessedBitmapCacheKey (ImageRequest request, Object callerContext)

Returns
  • CacheKey for doing post-processed bitmap cache lookups in the pipeline.