public static interface ImageDecoder.OnPartialImageListener

android.graphics.ImageDecoder.OnPartialImageListener



Interface for inspecting a DecodeException and potentially preventing it from being thrown.

If an instance is passed to setOnPartialImageListener, a DecodeException that would otherwise have been thrown can be inspected inside onPartialImage. If onPartialImage returns true, a partial image will be created.

Summary

Public methods

abstract boolean onPartialImage(ImageDecoder.DecodeException exception)

Called by ImageDecoder when there is only a partial image to display.

Public methods

onPartialImage

public abstract boolean onPartialImage (ImageDecoder.DecodeException exception)

Called by ImageDecoder when there is only a partial image to display.

If decoding is interrupted after having decoded a partial image, this method will be called. The implementation can inspect the DecodeException and optionally finish the rest of the decode creation process to create a partial Drawable or Bitmap.

Parameters
exception ImageDecoder.DecodeException: exception containing information about the decode interruption.
This value cannot be null.
Returns
boolean true to create and return a Drawable or Bitmap with partial data. false (which is the default) to abort the decode and throw e. Any undecoded lines in the image will be blank.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2026-02-13 UTC.