Package io.scanbot.sdk.imageprocessing

Enum Class DocumentCleanupStatus

java.lang.Object

java.lang.Enum<DocumentCleanupStatus>

io.scanbot.sdk.imageprocessing.DocumentCleanupStatus

All Implemented Interfaces:

Serializable, Comparable<DocumentCleanupStatus>, Constable

public enum DocumentCleanupStatus
extends Enum<DocumentCleanupStatus>

Status of the document cleanup operation.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR_MASK_TOO_LARGE	Cleanup was not performed because the axis-aligned bounding box of the non-zero mask pixels exceeded the configured maxMaskBoundingBoxArea limit.
OK	Cleanup completed.
OK_BUT_REDUCED_QUALITY	Cleanup completed, but the configured maxCleanupResolution forced internal downscaling of the cleanup region, so the result quality near the cleanup boundary may be reduced compared to a full-resolution run.

Method Summary

Modifier and Type	Method	Description
static DocumentCleanupStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocumentCleanupStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OK

public static final DocumentCleanupStatus OK

Cleanup completed.

OK_BUT_REDUCED_QUALITY

public static final DocumentCleanupStatus OK_BUT_REDUCED_QUALITY

Cleanup completed, but the configured maxCleanupResolution forced internal downscaling of the cleanup region, so the result quality near the cleanup boundary may be reduced compared to a full-resolution run. If result is not good enough, run undo and try applying cleanup on smaller areas.

ERROR_MASK_TOO_LARGE

public static final DocumentCleanupStatus ERROR_MASK_TOO_LARGE

Cleanup was not performed because the axis-aligned bounding box of the non-zero mask pixels exceeded the configured maxMaskBoundingBoxArea limit. The returned image is the current (unchanged) image and the undo/redo history is left untouched. Retry with a smaller mask or increase maxMaskBoundingBoxArea.

Method Details

values

public static DocumentCleanupStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DocumentCleanupStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null