Package io.scanbot.sdk.mrz

Enum Class MrzIncompleteResultHandling

java.lang.Object

java.lang.Enum<MrzIncompleteResultHandling>

io.scanbot.sdk.mrz.MrzIncompleteResultHandling

All Implemented Interfaces:

Serializable, Comparable<MrzIncompleteResultHandling>, Constable

public enum MrzIncompleteResultHandling
extends Enum<MrzIncompleteResultHandling>

Defines how to handle incomplete MRZ results (e.g. caused by failed validation).

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
ACCEPT	Accept incomplete results.
REJECT	Reject incomplete results.

Method Summary

Modifier and Type	Method	Description
static MrzIncompleteResultHandling	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MrzIncompleteResultHandling[]	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

ACCEPT

public static final MrzIncompleteResultHandling ACCEPT

Accept incomplete results. Fields failing validation will have a validation status of INVALID. Typically used for single-shot scanning.

REJECT

public static final MrzIncompleteResultHandling REJECT

Reject incomplete results. If any fields are missing or fail validation, the result document will be empty. Typically used for live scanning.

Method Details

values

public static MrzIncompleteResultHandling[] 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 MrzIncompleteResultHandling 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