Package io.scanbot.sdk.image

Enum Class ColorConversion

java.lang.Object

java.lang.Enum<ColorConversion>

io.scanbot.sdk.image.ColorConversion

All Implemented Interfaces:

Serializable, Comparable<ColorConversion>, Constable

public enum ColorConversion
extends Enum<ColorConversion>

Color conversion to apply during image loading.

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
ANY_COLOR	Load image as 3-channel BGR if the source color space is color, otherwise as single-channel grayscale.
COLOR	Load image as 3-channel BGR.
GRAY	Load image as grayscale.
UNCHANGED	Load image as-is, preserving the alpha channel if it exists.

Method Summary

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

GRAY

public static final ColorConversion GRAY

Load image as grayscale.

COLOR

public static final ColorConversion COLOR

Load image as 3-channel BGR.

ANY_COLOR

public static final ColorConversion ANY_COLOR

Load image as 3-channel BGR if the source color space is color, otherwise as single-channel grayscale. Alpha channel is discarded.

UNCHANGED

public static final ColorConversion UNCHANGED

Load image as-is, preserving the alpha channel if it exists.

Method Details

values

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