Enum DetectionStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DetectionStatus>

    public enum DetectionStatus
    extends java.lang.Enum<DetectionStatus>
    Indicates a detection status for detection result
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CAMERA_AT_ANGLE
      Object is detected, but camera is at too large angle to read it
      CAMERA_TOO_HIGH
      Object detected, but the camera is too far above to read it
      CAMERA_TOO_NEAR
      Object detected, but the camera is too close to read it
      DOCUMENT_TOO_CLOSE_TO_EDGE
      Document detected, but document is too close to the edge of the frame
      FAIL
      Detection failed, nothing detected
      FALLBACK_SUCCESS
      Object successfully detected in fallback mode
      PARTIAL_OBJECT
      Object is detected, but parts of it are not visible
      SUCCESS
      Object successfully detected
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static DetectionStatus fromNativeDetectionStatus​(int nativeDetectionStatus)
      converts bitmask-based detection status to enum
      static DetectionStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DetectionStatus[] 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

      • FAIL

        public static final DetectionStatus FAIL
        Detection failed, nothing detected
      • SUCCESS

        public static final DetectionStatus SUCCESS
        Object successfully detected
      • CAMERA_TOO_HIGH

        public static final DetectionStatus CAMERA_TOO_HIGH
        Object detected, but the camera is too far above to read it
      • FALLBACK_SUCCESS

        public static final DetectionStatus FALLBACK_SUCCESS
        Object successfully detected in fallback mode
      • PARTIAL_OBJECT

        public static final DetectionStatus PARTIAL_OBJECT
        Object is detected, but parts of it are not visible
      • CAMERA_AT_ANGLE

        public static final DetectionStatus CAMERA_AT_ANGLE
        Object is detected, but camera is at too large angle to read it
      • CAMERA_TOO_NEAR

        public static final DetectionStatus CAMERA_TOO_NEAR
        Object detected, but the camera is too close to read it
      • DOCUMENT_TOO_CLOSE_TO_EDGE

        public static final DetectionStatus DOCUMENT_TOO_CLOSE_TO_EDGE
        Document detected, but document is too close to the edge of the frame
    • Method Detail

      • values

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

        public static DetectionStatus 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
      • fromNativeDetectionStatus

        @NonNull
        public static DetectionStatus fromNativeDetectionStatus​(int nativeDetectionStatus)
        converts bitmask-based detection status to enum