ExtractedImage

java.lang.Object

io.scanbot.sdk.multipageimageextractor.ExtractedImage

All Implemented Interfaces:: AutoCloseable

public class ExtractedImage extends Object implements AutoCloseable

An image extracted from a multipage image.

Constructor Summary

Constructors

Constructor

Description

ExtractedImage(ImageRef image, ExtractedImageMetadata metadata)

Constructs ExtractedImage with the given params.
Method Summary

Modifier and Type

Method

Description

void

close()

Closes native resources (images) held by the object.

ImageRef

getImage()

Getter for image field.

ExtractedImageMetadata

getMetadata()

Getter for metadata field.

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

Constructor Details
- ExtractedImage
  
  public ExtractedImage(ImageRef image, ExtractedImageMetadata metadata)
  
  Constructs ExtractedImage with the given params.
  
  Parameters:
  
  image - The extracted image.
  
  metadata - Metadata of the extracted image.
Method Details
- getImage
  
  public ImageRef getImage()
  
  Getter for image field. See constructor documentation for more information about the field.
  
  Returns:
  
  image
- getMetadata
  
  public ExtractedImageMetadata getMetadata()
  
  Getter for metadata field. See constructor documentation for more information about the field.
  
  Returns:
  
  metadata
- close
  
  public void close()
  
  Closes native resources (images) held by the object.
  
  Specified by:
  
  close in interface AutoCloseable