eu.id3.document

## Enum DocumentModel

- java.lang.Object
- - java.lang.Enum<DocumentModel>
  - - eu.id3.document.DocumentModel

- All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DocumentModel>

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

  Enumerates the AI models available in this SDK.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `DOCUMENT_DETECTOR_2A` Document detector 2A.
    `DOCUMENT_DETECTOR_2B` Document detector 2B.
    `MRZ_READER_2A` MRZ Reader 2A.
    `OCR_LATIN_2A` OCR (Optical Character Recognition) model 2A for reading text fields in latin alphabet and digits.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static DocumentModel` | `fromValue(int value)` Creates an enumeration value from int.
    `int` | `getValue()` Gets the enumeration value as int.
    `static DocumentModel` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static DocumentModel[]` | `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

    - #### DOCUMENT_DETECTOR_2A

          public static final DocumentModel DOCUMENT_DETECTOR_2A

      Document detector 2A. Best accuracy model.

    - #### DOCUMENT_DETECTOR_2B

          public static final DocumentModel DOCUMENT_DETECTOR_2B

      Document detector 2B. Fast detector for low-end mobiles.

    - #### MRZ_READER_2A

          public static final DocumentModel MRZ_READER_2A

      MRZ Reader 2A. Stand-alone reader (no document detection needed).

    - #### OCR_LATIN_2A

          public static final DocumentModel OCR_LATIN_2A

      OCR (Optical Character Recognition) model 2A for reading text fields in latin alphabet and digits.

  - ### Method Detail

    - #### values

          public static DocumentModel[] 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 (DocumentModel c : DocumentModel.values())
              System.out.println(c);

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

    - #### valueOf

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

    - #### getValue

          public int getValue()

      Gets the enumeration value as int.
      Returns:
        The value.

    - #### fromValue

          public static DocumentModel fromValue(int value)

      Creates an enumeration value from int.
      Parameters:
        `value` - The int value.
      Returns:
        The created DocumentModel.

Copyright © 2020-2030, id3 Technologies. All rights reserved. eu.id3.document