java.lang.Object
- java.lang.Enum<DocumentDetectionStatus>
- - io.scanbot.sdk.documentscanner.DocumentDetectionStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentDetectionStatus>
```
public enum DocumentDetectionStatus
extends java.lang.Enum<DocumentDetectionStatus>
```
Status of the document detection.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ERROR_NOTHING_DETECTED`	No document was detected.
`ERROR_PARTIALLY_VISIBLE`	A document was detected, but not all of its corners are visible.
`ERROR_PARTIALLY_VISIBLE_TOO_CLOSE`	A document was detected, but not all of its corners are visible and the document is too close to the camera.
`ERROR_TOO_DARK`	No document was detected, likely because the input image is too dark.
`ERROR_TOO_NOISY`	No document was detected, likely because the input image is too noisy or has a complex background.
`NOT_ACQUIRED`	Detection has not yet happened.
`OK`	An acceptable document was detected.
`OK_BUT_BAD_ANGLES`	A document was detected, but it has too much perspective distortion.
`OK_BUT_BAD_ASPECT_RATIO`	A document was detected, but its aspect ratio is not acceptable.
`OK_BUT_OFF_CENTER`	A document was detected, but its center is too far away from the input image center.
`OK_BUT_ORIENTATION_MISMATCH`	A document was detected, but its orientation does not match the input image orientation.
`OK_BUT_TOO_DARK`	A document was detected, but it is too dark.
`OK_BUT_TOO_SMALL`	A document was detected, but it is too small.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static DocumentDetectionStatus`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static DocumentDetectionStatus[]`	`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
  - NOT_ACQUIRED
```
public static final DocumentDetectionStatus NOT_ACQUIRED
```
    Detection has not yet happened.
  - OK
```
public static final DocumentDetectionStatus OK
```
    An acceptable document was detected.
  - OK_BUT_TOO_SMALL
```
public static final DocumentDetectionStatus OK_BUT_TOO_SMALL
```
    A document was detected, but it is too small.
  - OK_BUT_BAD_ANGLES
```
public static final DocumentDetectionStatus OK_BUT_BAD_ANGLES
```
    A document was detected, but it has too much perspective distortion.
  - OK_BUT_BAD_ASPECT_RATIO
```
public static final DocumentDetectionStatus OK_BUT_BAD_ASPECT_RATIO
```
    A document was detected, but its aspect ratio is not acceptable.
  - OK_BUT_ORIENTATION_MISMATCH
```
public static final DocumentDetectionStatus OK_BUT_ORIENTATION_MISMATCH
```
    A document was detected, but its orientation does not match the input image orientation.
  - OK_BUT_OFF_CENTER
```
public static final DocumentDetectionStatus OK_BUT_OFF_CENTER
```
    A document was detected, but its center is too far away from the input image center. Deprecation Warning: This status is never returned by the document scanner.
  - OK_BUT_TOO_DARK
```
public static final DocumentDetectionStatus OK_BUT_TOO_DARK
```
    A document was detected, but it is too dark.
  - ERROR_NOTHING_DETECTED
```
public static final DocumentDetectionStatus ERROR_NOTHING_DETECTED
```
    No document was detected.
  - ERROR_PARTIALLY_VISIBLE
```
public static final DocumentDetectionStatus ERROR_PARTIALLY_VISIBLE
```
    A document was detected, but not all of its corners are visible.
  - ERROR_PARTIALLY_VISIBLE_TOO_CLOSE
```
public static final DocumentDetectionStatus ERROR_PARTIALLY_VISIBLE_TOO_CLOSE
```
    A document was detected, but not all of its corners are visible and the document is too close to the camera.
  - ERROR_TOO_DARK
```
public static final DocumentDetectionStatus ERROR_TOO_DARK
```
    No document was detected, likely because the input image is too dark.
  - ERROR_TOO_NOISY
```
public static final DocumentDetectionStatus ERROR_TOO_NOISY
```
    No document was detected, likely because the input image is too noisy or has a complex background. Deprecation Warning: This status is never returned by the document scanner.
- Method Detail
  - values
```
public static DocumentDetectionStatus[] 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 (DocumentDetectionStatus c : DocumentDetectionStatus.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DocumentDetectionStatus 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

Enum DocumentDetectionStatus

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NOT_ACQUIRED

OK

OK_BUT_TOO_SMALL

OK_BUT_BAD_ANGLES

OK_BUT_BAD_ASPECT_RATIO

OK_BUT_ORIENTATION_MISMATCH

OK_BUT_OFF_CENTER

OK_BUT_TOO_DARK

ERROR_NOTHING_DETECTED

ERROR_PARTIALLY_VISIBLE

ERROR_PARTIALLY_VISIBLE_TOO_CLOSE

ERROR_TOO_DARK

ERROR_TOO_NOISY

Method Detail

values

valueOf