Package io.scanbot.sdk.check

Enum CheckDocumentDetectionMode

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DETECT_AND_CROP_DOCUMENT
      Document scanner will be used to locate the complete check in the input image.
      DETECT_DOCUMENT
      Document scanner will be used to locate the complete check in the input image.
      DISABLED
      Document detection is not performed.

    • Method Summary

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

      • DISABLED

        public static final CheckDocumentDetectionMode DISABLED
        Document detection is not performed. Successful check scans will only contain the machine-readable check data without a full crop of the check.

      • DETECT_DOCUMENT

        public static final CheckDocumentDetectionMode DETECT_DOCUMENT
        Document scanner will be used to locate the complete check in the input image. The documentDetectionResult result field will contain the result of document detection.

      • DETECT_AND_CROP_DOCUMENT

        public static final CheckDocumentDetectionMode DETECT_AND_CROP_DOCUMENT
        Document scanner will be used to locate the complete check in the input image. The documentDetectionResult result field will contain the result of document detection. The croppedImage result field will contain a crop of the entire check.

    • Method Detail

      • values

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

      • valueOf

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