Package io.scanbot.sdk.documentscanner

Enum Class DocumentDisplacement

java.lang.Object
java.lang.Enum<DocumentDisplacement>
io.scanbot.sdk.documentscanner.DocumentDisplacement
All Implemented Interfaces:
Serializable, Comparable<DocumentDisplacement>, Constable
public enum DocumentDisplacement extends Enum<DocumentDisplacement>
The direction towards the center of the document if the document is partially visible.

  • Enum Constant Details

    • NONE

      public static final DocumentDisplacement NONE
      Either no document was detected, or the document is fully visible.

    • UP

      public static final DocumentDisplacement UP
      The document is partially visible. Move the camera up to capture the full document.

    • UPPER_RIGHT

      public static final DocumentDisplacement UPPER_RIGHT
      The document is partially visible. Move the camera up and to the right to capture the full document.

    • LOWER_RIGHT

      public static final DocumentDisplacement LOWER_RIGHT
      The document is partially visible. Move the camera down and to the right to capture the full document.

    • DOWN

      public static final DocumentDisplacement DOWN
      The document is partially visible. Move the camera down to capture the full document.

    • LOWER_LEFT

      public static final DocumentDisplacement LOWER_LEFT
      The document is partially visible. Move the camera down and to the left to capture the full document.

    • LEFT

      public static final DocumentDisplacement LEFT
      The document is partially visible. Move the camera to the left to capture the full document.

    • UPPER_LEFT

      public static final DocumentDisplacement UPPER_LEFT
      The document is partially visible. Move the camera up and to the left to capture the full document.

  • Method Details

    • values

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