DocumentStraighteningResult

java.lang.Object

io.scanbot.sdk.documentscanner.DocumentStraighteningResult

All Implemented Interfaces:: AutoCloseable

public class DocumentStraighteningResult extends Object implements AutoCloseable

Result of the document straightening.

Constructor Summary

Constructors

Constructor

Description

DocumentStraighteningResult()

Constructs DocumentStraighteningResult with default parameters.

DocumentStraighteningResult(ImageRef straightenedImage)

Constructs DocumentStraighteningResult with the given params.
Method Summary

Modifier and Type

Method

Description

void

close()

Closes native resources (images) held by the object.

ImageRef

getStraightenedImage()

Getter for straightenedImage field.

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

Constructor Details
- DocumentStraighteningResult
  
  public DocumentStraighteningResult(ImageRef straightenedImage)
  
  Constructs DocumentStraighteningResult with the given params.
  
  Parameters:
  
  straightenedImage - The straightened document image. Can be null if no document was detected.
- DocumentStraighteningResult
  
  public DocumentStraighteningResult()
  
  Constructs DocumentStraighteningResult with default parameters.
Method Details
- getStraightenedImage
  
  public ImageRef getStraightenedImage()
  
  Getter for straightenedImage field. See constructor documentation for more information about the field.
  
  Returns:
  
  straightenedImage
- close
  
  public void close()
  
  Closes native resources (images) held by the object.
  
  Specified by:
  
  close in interface AutoCloseable