Package io.scanbot.sdk.check

Enum Class CheckDocumentDetectionMode

java.lang.Object

java.lang.Enum<CheckDocumentDetectionMode>

io.scanbot.sdk.check.CheckDocumentDetectionMode

All Implemented Interfaces:

Serializable, Comparable<CheckDocumentDetectionMode>, Constable

public enum CheckDocumentDetectionMode
extends Enum<CheckDocumentDetectionMode>

Check document detection and extraction mode.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DETECT_AND_CROP_DOCUMENT	Document scanner will be used to locate the complete check in the input image.
DETECT_DOCUMENT	Document scanner will be used to locate the complete check in the input image.
DISABLED	Document detection is not performed.

Method Summary

Modifier and Type	Method	Description
static CheckDocumentDetectionMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CheckDocumentDetectionMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISABLED

public static final CheckDocumentDetectionMode DISABLED

Document detection is not performed. Successful check scans will only contain the machine-readable check data without a full crop of the check.

DETECT_DOCUMENT

public static final CheckDocumentDetectionMode DETECT_DOCUMENT

Document scanner will be used to locate the complete check in the input image. The documentDetectionResult result field will contain the result of document detection.

DETECT_AND_CROP_DOCUMENT

public static final CheckDocumentDetectionMode DETECT_AND_CROP_DOCUMENT

Document scanner will be used to locate the complete check in the input image. The documentDetectionResult result field will contain the result of document detection. The croppedImage result field will contain a crop of the entire check.

Method Details

values

public static CheckDocumentDetectionMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CheckDocumentDetectionMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null