Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#constants) \| [Methods](https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#inhmethods)

# ImageDecoder.DecodeException

*** ** * ** ***


`
public
static
final

class
ImageDecoder.DecodeException
`


`


`

`


`

`


`

`

extends https://developer.android.com/reference/java/io/IOException


`

`


`

|---|---|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||||
| ↳ | [java.lang.Throwable](https://developer.android.com/reference/java/lang/Throwable) ||||
|   | ↳ | [java.lang.Exception](https://developer.android.com/reference/java/lang/Exception) |||
|   |   | ↳ | [java.io.IOException](https://developer.android.com/reference/java/io/IOException) ||
|   |   |   | ↳ | android.graphics.ImageDecoder.DecodeException |

<br />

*** ** * ** ***

Information about an interrupted decode.

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#GAINMAP_EXTRACTION_FAILED` The extraction of the gainmap component of the image failed. |
| `int` | `https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#SOURCE_EXCEPTION` An Exception was thrown reading the `https://developer.android.com/reference/android/graphics/ImageDecoder.Source`. |
| `int` | `https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#SOURCE_INCOMPLETE` The encoded data was incomplete. |
| `int` | `https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#SOURCE_MALFORMED_DATA` The encoded data contained an error. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#getError()() ` Retrieve the reason that decoding was interrupted. |
| ` https://developer.android.com/reference/android/graphics/ImageDecoder.Source` | ` https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#getSource()() ` Retrieve the `https://developer.android.com/reference/android/graphics/ImageDecoder.Source` that was interrupted. |

### Inherited methods

From class `

https://developer.android.com/reference/java/lang/Throwable

` `


final

void` `
https://developer.android.com/reference/java/lang/Throwable#addSuppressed(java.lang.Throwable)(https://developer.android.com/reference/java/lang/Throwable exception)
`

Appends the specified exception to the exceptions that were
suppressed in order to deliver this exception.


`


https://developer.android.com/reference/java/lang/Throwable` `
https://developer.android.com/reference/java/lang/Throwable#fillInStackTrace()()
`

Fills in the execution stack trace.


`


https://developer.android.com/reference/java/lang/Throwable` `
https://developer.android.com/reference/java/lang/Throwable#getCause()()
`

Returns the cause of this throwable or `null` if the
cause is nonexistent or unknown.


`


https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Throwable#getLocalizedMessage()()
`

Creates a localized description of this throwable.


`


https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Throwable#getMessage()()
`

Returns the detail message string of this throwable.


`


https://developer.android.com/reference/java/lang/StackTraceElement` `
https://developer.android.com/reference/java/lang/Throwable#getStackTrace()()
`

Provides programmatic access to the stack trace information printed by
`https://developer.android.com/reference/java/lang/Throwable#printStackTrace()`.


`


final

https://developer.android.com/reference/java/lang/Throwable` `
https://developer.android.com/reference/java/lang/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.


`


https://developer.android.com/reference/java/lang/Throwable` `
https://developer.android.com/reference/java/lang/Throwable#initCause(java.lang.Throwable)(https://developer.android.com/reference/java/lang/Throwable cause)
`

Initializes the *cause* of this throwable to the specified value.


`


void` `
https://developer.android.com/reference/java/lang/Throwable#printStackTrace()()
`

Prints this throwable and its backtrace to the
standard error stream.


`


void` `
https://developer.android.com/reference/java/lang/Throwable#printStackTrace(java.io.PrintWriter)(https://developer.android.com/reference/java/io/PrintWriter s)
`

Prints this throwable and its backtrace to the specified
print writer.


`


void` `
https://developer.android.com/reference/java/lang/Throwable#printStackTrace(java.io.PrintStream)(https://developer.android.com/reference/java/io/PrintStream s)
`

Prints this throwable and its backtrace to the specified print stream.


`


void` `
https://developer.android.com/reference/java/lang/Throwable#setStackTrace(java.lang.StackTraceElement[])(https://developer.android.com/reference/java/lang/StackTraceElement stackTrace)
`

Sets the stack trace elements that will be returned by
`https://developer.android.com/reference/java/lang/Throwable#getStackTrace()` and printed by `https://developer.android.com/reference/java/lang/Throwable#printStackTrace()`
and related methods.


`


https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Throwable#toString()()
`

Returns a short description of this throwable.


From class `

https://developer.android.com/reference/java/lang/Object

` `


https://developer.android.com/reference/java/lang/Object` `
https://developer.android.com/reference/java/lang/Object#clone()()
`

Creates and returns a copy of this object.


`


boolean` `
https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj)
`

Indicates whether some other object is "equal to" this one.


`


void` `
https://developer.android.com/reference/java/lang/Object#finalize()()
`

Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.


`


final

https://developer.android.com/reference/java/lang/Class<?>` `
https://developer.android.com/reference/java/lang/Object#getClass()()
`

Returns the runtime class of this `Object`.


`


int` `
https://developer.android.com/reference/java/lang/Object#hashCode()()
`

Returns a hash code value for the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notify()()
`

Wakes up a single thread that is waiting on this object's
monitor.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notifyAll()()
`

Wakes up all threads that are waiting on this object's monitor.


`


https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Object#toString()()
`

Returns a string representation of the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` `
https://developer.android.com/reference/java/lang/Object#wait(long)(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` `
https://developer.android.com/reference/java/lang/Object#wait()()
`

Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*.


## Constants

### GAINMAP_EXTRACTION_FAILED

Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)

```
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
`https://developer.android.com/reference/android/graphics/ImageDecoder.OnPartialImageListener#onPartialImage(android.graphics.ImageDecoder.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.

<br />

Constant Value:

4
(0x00000004)


### SOURCE_EXCEPTION

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SOURCE_EXCEPTION
```

An Exception was thrown reading the `https://developer.android.com/reference/android/graphics/ImageDecoder.Source`.

<br />

Constant Value:

1
(0x00000001)


### SOURCE_INCOMPLETE

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SOURCE_INCOMPLETE
```

The encoded data was incomplete.

<br />

Constant Value:

2
(0x00000002)


### SOURCE_MALFORMED_DATA

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SOURCE_MALFORMED_DATA
```

The encoded data contained an error.

<br />

Constant Value:

3
(0x00000003)


## Public methods

### getError

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getError ()
```

Retrieve the reason that decoding was interrupted.

If the error is `https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#SOURCE_EXCEPTION`, the underlying
`https://developer.android.com/reference/java/lang/Throwable` can be retrieved with
`https://developer.android.com/reference/java/lang/Throwable#getCause()`.

<br />

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#SOURCE_EXCEPTION` - `https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#SOURCE_INCOMPLETE` - `https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#SOURCE_MALFORMED_DATA` - `https://developer.android.com/reference/android/graphics/ImageDecoder.DecodeException#GAINMAP_EXTRACTION_FAILED` |

### getSource

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ImageDecoder.Source getSource ()
```

Retrieve the `https://developer.android.com/reference/android/graphics/ImageDecoder.Source` that was interrupted.

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

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/ImageDecoder.Source` | This value cannot be `null`. <br /> |