Package io.scanbot.sdk.documentdata

Enum DocumentDataExtractionStatus

java.lang.Object

java.lang.Enum<DocumentDataExtractionStatus>

io.scanbot.sdk.documentdata.DocumentDataExtractionStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentDataExtractionStatus>

public enum DocumentDataExtractionStatus
extends java.lang.Enum<DocumentDataExtractionStatus>

The status of the extraction process.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR_BAD_CROP	A document was detected at an angle or distance that would result in a poor quality crop.
ERROR_NOTHING_FOUND	No document was detected.
ERROR_UNACCEPTABLE_DOCUMENT	A supported document was detected, but it is unacceptable in the current configuration.
ERROR_UNKNOWN_DOCUMENT	A document was detected, but it does not match any supported document format.
OK	The document data was extracted.
OK_BUT_INVALID_DOCUMENT	The document data was extracted.
OK_BUT_NOT_CONFIRMED	The document data was extracted.
SCANNING_IN_PROGRESS_STILL_FOCUSING	Document data extraction in progress.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OK

public static final DocumentDataExtractionStatus OK

The document data was extracted.

OK_BUT_INVALID_DOCUMENT

public static final DocumentDataExtractionStatus OK_BUT_INVALID_DOCUMENT

The document data was extracted. Some fields in the document have failed validation, e.g. because the document is damaged, not authentic, or does not have all required fields.

OK_BUT_NOT_CONFIRMED

public static final DocumentDataExtractionStatus OK_BUT_NOT_CONFIRMED

The document data was extracted. Some fields have not yet been confirmed.

SCANNING_IN_PROGRESS_STILL_FOCUSING

public static final DocumentDataExtractionStatus SCANNING_IN_PROGRESS_STILL_FOCUSING

Document data extraction in progress. Waiting for camera to finish focusing.

ERROR_NOTHING_FOUND

public static final DocumentDataExtractionStatus ERROR_NOTHING_FOUND

No document was detected.

ERROR_BAD_CROP

public static final DocumentDataExtractionStatus ERROR_BAD_CROP

A document was detected at an angle or distance that would result in a poor quality crop.

ERROR_UNKNOWN_DOCUMENT

public static final DocumentDataExtractionStatus ERROR_UNKNOWN_DOCUMENT

A document was detected, but it does not match any supported document format.

ERROR_UNACCEPTABLE_DOCUMENT

public static final DocumentDataExtractionStatus ERROR_UNACCEPTABLE_DOCUMENT

A supported document was detected, but it is unacceptable in the current configuration.

Method Detail

values

public static DocumentDataExtractionStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DocumentDataExtractionStatus c : DocumentDataExtractionStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static DocumentDataExtractionStatus valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null