Package io.scanbot.sdk.image

Enum Class CanvasColor

java.lang.Object

java.lang.Enum<CanvasColor>

io.scanbot.sdk.image.CanvasColor

All Implemented Interfaces:

Serializable, Comparable<CanvasColor>, Constable

public enum CanvasColor
extends Enum<CanvasColor>

Canvas color to use when converting images with alpha channel to images without alpha channel.

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
BLACK	Black canvas color.
WHITE	White canvas color.

Method Summary

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

WHITE

public static final CanvasColor WHITE

White canvas color.

BLACK

public static final CanvasColor BLACK

Black canvas color.

Method Details

values

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