All Implemented Interfaces:

java.io.Closeable , java.lang.AutoCloseable
```
@Immutable() 
public class EncodedImage
 implements Closeable
                    
```
Class that contains all the information for an encoded image, both the image bytes (held on a byte buffer or a supplier of input streams) and the extracted meta data that is useful for image transforms.
Only one of the input stream supplier or the byte buffer can be set. If using an input stream supplier, the methods that return a byte buffer will simply return null. However, getInputStream will always be supported, either from the supplier or an input stream created from the byte buffer held.
Currently the data is useful for rotation and resize.

Field Summary

Fields
Modifier and Type	Field	Description
`public final static int`	`UNKNOWN_ROTATION_ANGLE`
`public final static int`	`UNKNOWN_WIDTH`
`public final static int`	`UNKNOWN_HEIGHT`
`public final static int`	`UNKNOWN_STREAM_SIZE`
`public final static int`	`DEFAULT_SAMPLE_SIZE`

Constructor Summary

Constructors
Constructor	Description
`EncodedImage(CloseableReference<PooledByteBuffer> pooledByteBufferRef)`
`EncodedImage(Supplier<FileInputStream> inputStreamSupplier)`
`EncodedImage(Supplier<FileInputStream> inputStreamSupplier, int streamSize)`

Method Summary

Modifier and Type	Method	Description
`static EncodedImage`	`cloneOrNull(@Nullable() EncodedImage encodedImage)`	Returns the cloned encoded image if the parameter received is not null, null otherwise.
`EncodedImage`	`cloneOrNull()`
`void`	`close()`	Closes the buffer enclosed by this class.
`synchronized boolean`	`isValid()`	Returns true if the internal buffer reference is valid or the InputStream Supplier is not null,false otherwise.
`CloseableReference<PooledByteBuffer>`	`getByteBufferRef()`	Returns a cloned reference to the stored encoded bytes.
`InputStream`	`getInputStream()`	Returns an InputStream from the internal InputStream Supplier if it's not null.
`InputStream`	`getInputStreamOrThrow()`
`void`	`setImageFormat(ImageFormat imageFormat)`	Sets the image format
`void`	`setHeight(int height)`	Sets the image height
`void`	`setWidth(int width)`	Sets the image width
`void`	`setRotationAngle(int rotationAngle)`	Sets the image rotation angle
`void`	`setExifOrientation(int exifOrientation)`	Sets the exif orientation
`void`	`setSampleSize(int sampleSize)`	Sets the image sample size
`void`	`setStreamSize(int streamSize)`	Sets the size of an image if backed by an InputStreamIgnored if backed by a ByteBuffer
`void`	`setBytesRange(@Nullable() BytesRange bytesRange)`
`void`	`setSource(@Nullable() String source)`
`String`	`getSource()`
`ImageFormat`	`getImageFormat()`	Returns the image format if known, otherwise ImageFormat.UNKNOWN.
`int`	`getRotationAngle()`
`int`	`getExifOrientation()`	Returns the exif orientation if known (1 - 8), else 0.
`int`	`getWidth()`	Returns the image width if known, else -1.
`int`	`getHeight()`	Returns the image height if known, else -1.
`ColorSpace`	`getColorSpace()`	The color space is always null if Android API level < 26.
`int`	`getSampleSize()`	Only valid if the image format is JPEG.
`BytesRange`	`getBytesRange()`
`boolean`	`isCompleteAt(int length)`	Returns true if the image is a JPEG or DNG and its data is already complete at the specifiedlength, false otherwise.
`int`	`getSize()`	Returns the size of the backing structure.
`String`	`getFirstBytesAsHexString(int length)`	Returns first n bytes of encoded image as hexbytes
`void`	`parseMetaData()`
`void`	`copyMetaDataFrom(EncodedImage encodedImage)`	Copy the meta data from another EncodedImage.
`static boolean`	`isMetaDataAvailable(EncodedImage encodedImage)`	Returns true if all the image information has loaded, false otherwise.
`static void`	`closeSafely(@Nullable() EncodedImage encodedImage)`	Closes the encoded image handling null.
`static boolean`	`isValid(@Nullable() EncodedImage encodedImage)`	Checks if the encoded image is valid i.e.
`synchronized SharedReference<PooledByteBuffer>`	`getUnderlyingReferenceTestOnly()`	A test-only method to get the underlying references.
`static void`	`setUseCachedMetadata(boolean useCachedMetadata)`

Methods inherited from class java.io.Closeable
close
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EncodedImage
```
EncodedImage(CloseableReference<PooledByteBuffer> pooledByteBufferRef)
```
  - EncodedImage
```
EncodedImage(Supplier<FileInputStream> inputStreamSupplier)
```
  - EncodedImage
```
EncodedImage(Supplier<FileInputStream> inputStreamSupplier, int streamSize)
```
- Method Detail
  - cloneOrNull
```
@Nullable() static EncodedImage cloneOrNull(@Nullable() EncodedImage encodedImage)
```
    Returns the cloned encoded image if the parameter received is not null, null otherwise.
    
    Parameters:
    
    encodedImage - the EncodedImage to clone
  - cloneOrNull
```
@Nullable() EncodedImage cloneOrNull()
```
  - close
```
 void close()
```
    Closes the buffer enclosed by this class.
  - isValid
```
 synchronized boolean isValid()
```
    Returns true if the internal buffer reference is valid or the InputStream Supplier is not null,false otherwise.
  - getByteBufferRef
```
 CloseableReference<PooledByteBuffer> getByteBufferRef()
```
    Returns a cloned reference to the stored encoded bytes.
    The caller has to close the reference once it has finished using it.
  - getInputStream
```
@Nullable() InputStream getInputStream()
```
    Returns an InputStream from the internal InputStream Supplier if it's not null. Otherwisereturns an InputStream for the internal buffer reference if valid and null otherwise.
    The caller has to close the InputStream after using it.
  - getInputStreamOrThrow
```
 InputStream getInputStreamOrThrow()
```
  - setImageFormat
```
 void setImageFormat(ImageFormat imageFormat)
```
    Sets the image format
  - setHeight
```
 void setHeight(int height)
```
    Sets the image height
  - setWidth
```
 void setWidth(int width)
```
    Sets the image width
  - setRotationAngle
```
 void setRotationAngle(int rotationAngle)
```
    Sets the image rotation angle
  - setExifOrientation
```
 void setExifOrientation(int exifOrientation)
```
    Sets the exif orientation
  - setSampleSize
```
 void setSampleSize(int sampleSize)
```
    Sets the image sample size
  - setStreamSize
```
 void setStreamSize(int streamSize)
```
    Sets the size of an image if backed by an InputStream
    Ignored if backed by a ByteBuffer
  - setBytesRange
```
 void setBytesRange(@Nullable() BytesRange bytesRange)
```
  - setSource
```
 void setSource(@Nullable() String source)
```
  - getSource
```
@Nullable() String getSource()
```
  - getImageFormat
```
 ImageFormat getImageFormat()
```
    Returns the image format if known, otherwise ImageFormat.UNKNOWN.
  - getRotationAngle
```
 int getRotationAngle()
```
  - getExifOrientation
```
 int getExifOrientation()
```
    Returns the exif orientation if known (1 - 8), else 0.
  - getWidth
```
 int getWidth()
```
    Returns the image width if known, else -1.
  - getHeight
```
 int getHeight()
```
    Returns the image height if known, else -1.
  - getColorSpace
```
@Nullable() ColorSpace getColorSpace()
```
    The color space is always null if Android API level < 26.
  - getSampleSize
```
 int getSampleSize()
```
    Only valid if the image format is JPEG.
  - getBytesRange
```
@Nullable() BytesRange getBytesRange()
```
  - isCompleteAt
```
 boolean isCompleteAt(int length)
```
    Returns true if the image is a JPEG or DNG and its data is already complete at the specifiedlength, false otherwise.
  - getSize
```
 int getSize()
```
    Returns the size of the backing structure.
    If it's a PooledByteBuffer returns its size if its not null, -1 otherwise. If it's anInputStream, return the size if it was set, -1 otherwise.
  - getFirstBytesAsHexString
```
 String getFirstBytesAsHexString(int length)
```
    Returns first n bytes of encoded image as hexbytes
    
    Parameters:
    
    length - the number of bytes to return
  - parseMetaData
```
 void parseMetaData()
```
  - copyMetaDataFrom
```
 void copyMetaDataFrom(EncodedImage encodedImage)
```
    Copy the meta data from another EncodedImage.
    
    Parameters:
    
    encodedImage - the EncodedImage to copy the meta data from.
  - isMetaDataAvailable
```
 static boolean isMetaDataAvailable(EncodedImage encodedImage)
```
    Returns true if all the image information has loaded, false otherwise.
  - closeSafely
```
 static void closeSafely(@Nullable() EncodedImage encodedImage)
```
    Closes the encoded image handling null.
    
    Parameters:
    
    encodedImage - the encoded image to close.
  - isValid
```
 static boolean isValid(@Nullable() EncodedImage encodedImage)
```
    Checks if the encoded image is valid i.e. is not null, and is not closed.
  - getUnderlyingReferenceTestOnly
```
@Nullable() synchronized SharedReference<PooledByteBuffer> getUnderlyingReferenceTestOnly()
```
    A test-only method to get the underlying references.
    DO NOT USE in application code.
  - setUseCachedMetadata
```
 static void setUseCachedMetadata(boolean useCachedMetadata)
```

Class EncodedImage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.io.Closeable

Methods inherited from class java.lang.Object

Constructor Detail

EncodedImage

EncodedImage

EncodedImage

Method Detail

cloneOrNull

cloneOrNull

close

isValid

getByteBufferRef

getInputStream

getInputStreamOrThrow

setImageFormat

setHeight

setWidth

setRotationAngle

setExifOrientation

setSampleSize

setStreamSize

setBytesRange

setSource

getSource

getImageFormat

getRotationAngle

getExifOrientation

getWidth

getHeight

getColorSpace

getSampleSize

getBytesRange

isCompleteAt

getSize

getFirstBytesAsHexString

parseMetaData

copyMetaDataFrom

isMetaDataAvailable

closeSafely

isValid

getUnderlyingReferenceTestOnly

setUseCachedMetadata