Package io.scanbot.sdk.check

Class CheckScanner

java.lang.Object

io.scanbot.sdk.check.CheckScanner

All Implemented Interfaces:

AutoCloseable

public class CheckScanner
extends Object
implements AutoCloseable

API for check scanning. Required licence feature(s): CheckScanner.

Constructor Summary

Constructors

Constructor	Description
CheckScanner(CheckScannerConfiguration configuration)	Constructs CheckScanner with the given params.

Method Summary

Modifier and Type	Method	Description
void	clearResult()	Clears the accumulated results.
void	close()	Closes native resources held by the object.
protected void	finalize()
CheckScanningResult	run(ImageRef image)	Scan check in the given image.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CheckScanner

public CheckScanner(CheckScannerConfiguration configuration)
             throws LicenseException

Constructs CheckScanner with the given params.

Parameters:

configuration - The configuration to use for the check scanner.

Throws:

LicenseException - If license requirements for the API are not met

Method Details

run

public CheckScanningResult run(ImageRef image)
                        throws InvalidImageRefException,
LicenseException

Scan check in the given image.

Parameters:

image - The image to scan check in.

Returns:

The check scanning result.

Throws:

InvalidImageRefException - If an invalid image reference is used

LicenseException - If license requirements for the API are not met

clearResult

public void clearResult()

Clears the accumulated results. Should be called after a document has been scanned to the customer's satisfaction to prevent a poisoned cache.

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