DocumentScanningResult

java.lang.Object

io.scanbot.sdk.documentscanner.DocumentScanningResult

All Implemented Interfaces:: AutoCloseable

public class DocumentScanningResult extends Object implements AutoCloseable

Result of the document detection followed by cropping of the found document.

Constructor Summary

Constructors

Constructor

Description

DocumentScanningResult(DocumentDetectionResult detectionResult)

Constructs DocumentScanningResult with default parameters.

DocumentScanningResult(DocumentDetectionResult detectionResult, ImageRef croppedImage)

Constructs DocumentScanningResult with the given params.
Method Summary

Modifier and Type

Method

Description

void

close()

Closes native resources (images) held by the object.

ImageRef

getCroppedImage()

Getter for croppedImage field.

DocumentDetectionResult

getDetectionResult()

Getter for detectionResult field.

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

Constructor Details
- DocumentScanningResult
  
  public DocumentScanningResult(DocumentDetectionResult detectionResult, ImageRef croppedImage)
  
  Constructs DocumentScanningResult with the given params.
  
  Parameters:
  
  detectionResult - Result of the document contour detection.
  
  croppedImage - Cropped document image.
- DocumentScanningResult
  
  public DocumentScanningResult(DocumentDetectionResult detectionResult)
  
  Constructs DocumentScanningResult with default parameters.
  
  Parameters:
  
  detectionResult - Result of the document contour detection.
Method Details
- getDetectionResult
  
  public DocumentDetectionResult getDetectionResult()
  
  Getter for detectionResult field. See constructor documentation for more information about the field.
  
  Returns:
  
  detectionResult
- getCroppedImage
  
  public ImageRef getCroppedImage()
  
  Getter for croppedImage field. See constructor documentation for more information about the field.
  
  Returns:
  
  croppedImage
- close
  
  public void close()
  
  Closes native resources (images) held by the object.
  
  Specified by:
  
  close in interface AutoCloseable