Package io.scanbot.sdk.imageprocessing

Enum Class PageBinarization

java.lang.Object

java.lang.Enum<PageBinarization>

io.scanbot.sdk.imageprocessing.PageBinarization

All Implemented Interfaces:

Serializable, Comparable<PageBinarization>, Constable

public enum PageBinarization
extends Enum<PageBinarization>

Binarization behavior to apply when adding a page to a PDF/TIFF.

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
DISABLED	Do not binarize the image.
ENABLED	Binarize the image.
ENABLED_IF_BINARIZATION_FILTER_SET	Same behavior as ENABLED if a binarizationFilter is set, otherwise same behavior as DISABLED.

Method Summary

Modifier and Type	Method	Description
static PageBinarization	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PageBinarization[]	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

DISABLED

public static final PageBinarization DISABLED

Do not binarize the image.

ENABLED

public static final PageBinarization ENABLED

Binarize the image. Image will be stored as a compressed black-and-white image. This will result in a very small file size. If binarizationFilter is set, this binarization filter will be applied. Otherwise, a simple thresholding binarization will be applied.

ENABLED_IF_BINARIZATION_FILTER_SET

public static final PageBinarization ENABLED_IF_BINARIZATION_FILTER_SET

Same behavior as ENABLED if a binarizationFilter is set, otherwise same behavior as DISABLED. This is the default.

Method Details

values

public static PageBinarization[] 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 PageBinarization 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