DocumentCleanupResult

java.lang.Object

io.scanbot.sdk.imageprocessing.DocumentCleanupResult

All Implemented Interfaces:: AutoCloseable

public class DocumentCleanupResult extends Object implements AutoCloseable

Result of a document cleanup run.

Constructor Summary

Constructors

Constructor

Description

DocumentCleanupResult(ImageRef image)

Constructs DocumentCleanupResult with default parameters.

DocumentCleanupResult(DocumentCleanupStatus status, ImageRef image)

Constructs DocumentCleanupResult 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.

DocumentCleanupStatus

getStatus()

Getter for status field.

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

Constructor Details
- DocumentCleanupResult
  
  public DocumentCleanupResult(DocumentCleanupStatus status, ImageRef image)
  
  Constructs DocumentCleanupResult with the given params.
  
  Parameters:
  
  status - Status of the cleanup operation. Default is `OK`.
  
  image - Cleaned up image.
- DocumentCleanupResult
  
  public DocumentCleanupResult(ImageRef image)
  
  Constructs DocumentCleanupResult with default parameters.
  
  Parameters:
  
  image - Cleaned up image.
Method Details
- getStatus
  
  public DocumentCleanupStatus getStatus()
  
  Getter for status field. See constructor documentation for more information about the field.
  
  Returns:
  
  status
- getImage
  
  public ImageRef getImage()
  
  Getter for image field. See constructor documentation for more information about the field.
  
  Returns:
  
  image
- close
  
  public void close()
  
  Closes native resources (images) held by the object.
  
  Specified by:
  
  close in interface AutoCloseable