Package io.scanbot.sdk.documentscanner

Enum DocumentDisplacement

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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DOWN
      The document is partially visible.
      LEFT
      The document is partially visible.
      LOWER_LEFT
      The document is partially visible.
      LOWER_RIGHT
      The document is partially visible.
      NONE
      The document is fully visible.
      RIGHT
      The document is partially visible.
      UP
      The document is partially visible.
      UPPER_LEFT
      The document is partially visible.
      UPPER_RIGHT
      The document is partially visible.

    • Method Summary

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

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

      • RIGHT

        public static final DocumentDisplacement RIGHT
        The document is partially visible. Move the camera 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 Detail

      • values

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

      • valueOf

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