public abstract class

BasePostprocessor

extends Object
implements Postprocessor
java.lang.Object
   ↳ com.facebook.imagepipeline.request.BasePostprocessor
Known Direct Subclasses

Class Overview

Base implementation of Postprocessor interface.

Clients should override exactly one of the three provided process(Bitmap) methods.

Summary

Public Constructors
BasePostprocessor()
Public Methods
String getName()
Returns the name of this postprocessor.
CacheKey getPostprocessorCacheKey()
The default implementation of the CacheKey for a Postprocessor is null
CloseableReference<Bitmap> process(Bitmap sourceBitmap, PlatformBitmapFactory bitmapFactory)
Clients should override this method only if the post-processed bitmap has to be of a different size than the source bitmap.
void process(Bitmap destBitmap, Bitmap sourceBitmap)
Clients should override this method if the post-processing cannot be done in place.
void process(Bitmap bitmap)
Clients should override this method if the post-processing can be done in place.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.facebook.imagepipeline.request.Postprocessor

Public Constructors

public BasePostprocessor ()

Public Methods

public String getName ()

Returns the name of this postprocessor.

Used for logging and analytics.

public CacheKey getPostprocessorCacheKey ()

The default implementation of the CacheKey for a Postprocessor is null

Returns
  • The CacheKey to use for caching. Not used if null

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

Clients should override this method only if the post-processed bitmap has to be of a different size than the source bitmap. If the post-processed bitmap is of the same size, clients should override one of the other two methods.

The source bitmap must not be modified 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. Clients should use bitmapFactory to create a new bitmap.

Parameters
sourceBitmap The source bitmap.
bitmapFactory The factory to create a destination bitmap.
Returns
  • a reference to the newly created bitmap

public void process (Bitmap destBitmap, Bitmap sourceBitmap)

Clients should override this method if the post-processing cannot be done in place. If the post-processing can be done in place, clients should override the process(Bitmap) method.

The provided destination bitmap is of the same size as the source bitmap. There are no guarantees on the initial content of the destination bitmap, so the implementation has to make sure that it properly populates it.

The source bitmap must not be modified as it may be shared by the other clients. The implementation must use the provided destination bitmap as its output.

Parameters
destBitmap the destination bitmap to be used as output
sourceBitmap the source bitmap to be used as input

public void process (Bitmap bitmap)

Clients should override this method if the post-processing can be done in place.

The provided bitmap is a copy of the source bitmap and the implementation is free to modify it.

Parameters
bitmap the bitmap to be used both as input and as output