ImageDecoder.DecodeException

Kotlin |Java

public static final class ImageDecoder.DecodeException
extends IOException

java.lang.Object
↳	java.lang.Throwable
	↳	java.lang.Exception
		↳	java.io.IOException
			↳	android.graphics.ImageDecoder.DecodeException

Information about an interrupted decode.

Summary

Constants
`int`	`GAINMAP_EXTRACTION_FAILED` The extraction of the gainmap component of the image failed.
`int`	`SOURCE_EXCEPTION` An Exception was thrown reading the `Source`.
`int`	`SOURCE_INCOMPLETE` The encoded data was incomplete.
`int`	`SOURCE_MALFORMED_DATA` The encoded data contained an error.

Public methods
`int`	`getError()` Retrieve the reason that decoding was interrupted.
`ImageDecoder.Source`	`getSource()` Retrieve the `Source` that was interrupted.

Inherited methods

From class


        
          java.lang.Throwable

`final void`	`addSuppressed(Throwable exception)` Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
`Throwable`	`fillInStackTrace()` Fills in the execution stack trace.
`Throwable`	`getCause()` Returns the cause of this throwable or `null` if the cause is nonexistent or unknown.
`String`	`getLocalizedMessage()` Creates a localized description of this throwable.
`String`	`getMessage()` Returns the detail message string of this throwable.
`StackTraceElement[]`	`getStackTrace()` Provides programmatic access to the stack trace information printed by `printStackTrace()`.
`final Throwable[]`	`getSuppressed()` Returns an array containing all of the exceptions that were suppressed, typically by the `try`-with-resources statement, in order to deliver this exception.
`Throwable`	`initCause(Throwable cause)` Initializes the cause of this throwable to the specified value.
`void`	`printStackTrace()` Prints this throwable and its backtrace to the standard error stream.
`void`	`printStackTrace(PrintWriter s)` Prints this throwable and its backtrace to the specified print writer.
`void`	`printStackTrace(PrintStream s)` Prints this throwable and its backtrace to the specified print stream.
`void`	`setStackTrace(StackTraceElement[] stackTrace)` Sets the stack trace elements that will be returned by `getStackTrace()` and printed by `printStackTrace()` and related methods.
`String`	`toString()` Returns a short description of this throwable.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

GAINMAP_EXTRACTION_FAILED

Added in API level 10000

public static final int GAINMAP_EXTRACTION_FAILED

The extraction of the gainmap component of the image failed. If the partially decoded result is returned by returning true from OnPartialImageListener.onPartialImage(DecodeException) there will still be a complete base image to be viewed. It is thus recommended to return the partial image and proceed with displaying it. Applications that are doing this for editing or similar may want to consider warning the user that data was lost.

Constant Value: 4 (0x00000004)

SOURCE_EXCEPTION

Added in API level 28

public static final int SOURCE_EXCEPTION

An Exception was thrown reading the Source.

Constant Value: 1 (0x00000001)

SOURCE_INCOMPLETE

Added in API level 28

public static final int SOURCE_INCOMPLETE

The encoded data was incomplete.

Constant Value: 2 (0x00000002)

SOURCE_MALFORMED_DATA

Added in API level 28

public static final int SOURCE_MALFORMED_DATA

The encoded data contained an error.

Constant Value: 3 (0x00000003)

Public methods

getError

Added in API level 28

public int getError ()

Retrieve the reason that decoding was interrupted.

If the error is SOURCE_EXCEPTION, the underlying Throwable can be retrieved with Throwable.getCause().

Returns
`int`	Value is one of the following: `SOURCE_EXCEPTION` `SOURCE_INCOMPLETE` `SOURCE_MALFORMED_DATA` `GAINMAP_EXTRACTION_FAILED`

getSource

Added in API level 28

public ImageDecoder.Source getSource ()

Retrieve the Source that was interrupted.

This can be used for equality checking to find the Source which failed to completely decode.

Returns
`ImageDecoder.Source`	This value cannot be `null`.