Package io.scanbot.sdk.mrz

Enum MrzIncompleteResultHandling

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<MrzIncompleteResultHandling>
    public enum MrzIncompleteResultHandling
extends java.lang.Enum<MrzIncompleteResultHandling>
    Defines how to handle incomplete MRZ results (e.g. caused by failed validation).

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACCEPT
      Accept incomplete results.
      REJECT
      Reject incomplete results.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static MrzIncompleteResultHandling valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static MrzIncompleteResultHandling[] 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

      • 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 Detail

      • values

        public static MrzIncompleteResultHandling[] 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 (MrzIncompleteResultHandling c : MrzIncompleteResultHandling.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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