eu.id3.document

## Enum DocumentFormat

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

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

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

  Enumerates document formats, according to ISO/IEC 7810.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `A4` A4 format document
    `ID1` ID-1 format.
    `ID2` ID-2 format.
    `ID3` ID-3 format.
    `UNKNOWN` Unknown document format.

  - ### Method Summary

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

    - #### UNKNOWN

          public static final DocumentFormat UNKNOWN

      Unknown document format.

    - #### A4

          public static final DocumentFormat A4

      A4 format document

    - #### ID1

          public static final DocumentFormat ID1

      ID-1 format. Specifies a size of 85.60 by 53.98 millimetres. This format is commonly used for most banking cards and ID cards.

    - #### ID2

          public static final DocumentFormat ID2

      ID-2 format. Specifies a size of 105 by 74 millimetres. This format is used for visas, Romanian and other ID cards. Visas.

    - #### ID3

          public static final DocumentFormat ID3

      ID-3 format. Specifies a size of 125 by 88 millimetres. This format is commonly used for passport booklets.

  - ### Method Detail

    - #### values

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

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

    - #### valueOf

          public static DocumentFormat 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 DocumentFormat fromValue(int value)

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

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