DocumentQualityAnalyzer

java.lang.Object

io.scanbot.sdk.documentqualityanalyzer.DocumentQualityAnalyzer

All Implemented Interfaces:: AutoCloseable

public class DocumentQualityAnalyzer extends Object implements AutoCloseable

API for analyzing document quality. Required licence feature(s): ImageProcessing.

Constructor Summary

Constructors

Constructor

Description

DocumentQualityAnalyzer(DocumentQualityAnalyzerConfiguration configuration)

Constructs DocumentQualityAnalyzer with the given params.
Method Summary

Modifier and Type

Method

Description

void

close()

Closes native resources held by the object.

protected void

finalize()

DocumentQualityAnalyzerResult

run(ImageRef image)

analyze document quality of the given image.

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

Constructor Details
- DocumentQualityAnalyzer
  
  public DocumentQualityAnalyzer(DocumentQualityAnalyzerConfiguration configuration) throws LicenseException
  
  Constructs DocumentQualityAnalyzer with the given params.
  
  Parameters:
  
  configuration - The configuration to use for the document quality analyzer.
  
  Throws:
  
  LicenseException - If license requirements for the API are not met
Method Details
- run
  
  public DocumentQualityAnalyzerResult run(ImageRef image) throws InvalidImageRefException, LicenseException
  
  analyze document quality of the given image.
  
  Parameters:
  
  image - The image to analyze.
  
  Returns:
  
  The analyzed document quality.
  
  Throws:
  
  InvalidImageRefException - If an invalid image reference is used
  
  LicenseException - If license requirements for the API are not met
- close
  
  public void close()
  
  Closes native resources held by the object.
  
  Specified by:
  
  close in interface AutoCloseable
- finalize
  
  protected void finalize() throws Throwable
  
  Overrides:
  
  finalize in class Object
  
  Throws:
  
  Throwable