public interface

Postprocessor

com.facebook.imagepipeline.request.Postprocessor
Known Indirect Subclasses

Class Overview

Use an instance of this class to perform post-process operations on a bitmap.

Summary

Public Methods
abstract String getName()
Returns the name of this postprocessor.
abstract CacheKey getPostprocessorCacheKey()
Implement this method in order to cache the result of a postprocessor in the bitmap cache along with the unmodified image.
abstract CloseableReference<Bitmap> process(Bitmap sourceBitmap, PlatformBitmapFactory bitmapFactory)
Called by the pipeline after completing other steps.

Public Methods

public abstract String getName ()

Returns the name of this postprocessor.

Used for logging and analytics.

public abstract CacheKey getPostprocessorCacheKey ()

Implement this method in order to cache the result of a postprocessor in the bitmap cache along with the unmodified image.

When reading from memory cache, there will be a hit only if the cache's value for this key matches that of the request.

Each postprocessor class is only allowed one entry in the cache. When writing to memory cache, this key is not considered and any image for this request with the same postprocessor class will be overwritten.

Returns
  • The CacheKey to use for the result of this postprocessor

public abstract CloseableReference<Bitmap> process (Bitmap sourceBitmap, PlatformBitmapFactory bitmapFactory)

Called by the pipeline after completing other steps.

Parameters
sourceBitmap The source bitmap.
bitmapFactory The factory to create a destination bitmap.

The Postprocessor must not modify the source bitmap as it may be shared by the other clients. The implementation must create a new bitmap that is safe to be modified and return a reference to it. To create a bitmap, use the provided bitmapFactory.