Enum RecognitionSuccessType

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

    public enum RecognitionSuccessType
    extends java.lang.Enum<RecognitionSuccessType>
    Type of recognition that has been performed.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      PARTIAL
      Recognition was partial (some data found).
      STAGE_SUCCESSFUL
      Recognition has successfully completed one stage (one side of the document has been scanned).
      SUCCESSFUL
      Recognition performed successfully (all data found).
      UNSUCCESSFUL
      Recognition performed unsuccessfully (no data found).
    • Enum Constant Detail

      • UNSUCCESSFUL

        public static final RecognitionSuccessType UNSUCCESSFUL
        Recognition performed unsuccessfully (no data found). Returned when all used recognizers have empty results.
      • PARTIAL

        public static final RecognitionSuccessType PARTIAL
        Recognition was partial (some data found). Returned when at least one recognizer result is uncertain and no recognizer result is valid or stage valid.
      • SUCCESSFUL

        public static final RecognitionSuccessType SUCCESSFUL
        Recognition performed successfully (all data found). Returned when at least one recognizer has valid result.
      • STAGE_SUCCESSFUL

        public static final RecognitionSuccessType STAGE_SUCCESSFUL
        Recognition has successfully completed one stage (one side of the document has been scanned). Returned when at least one recognizer result is stage valid and no recognizer result is valid.
    • Method Detail

      • values

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

        public static RecognitionSuccessType 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
      • fromNativeRecognitionState

        public static RecognitionSuccessType fromNativeRecognitionState​(int nativeState)