Package io.scanbot.sdk.image

Enum Class PathLoadMode

java.lang.Object

java.lang.Enum<PathLoadMode>

io.scanbot.sdk.image.PathLoadMode

All Implemented Interfaces:

Serializable, Comparable<PathLoadMode>, Constable

public enum PathLoadMode
extends Enum<PathLoadMode>

Image Ref Path Load Mode.

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
EAGER	Image is immediately loaded into memory.
LAZY	Image is loaded into memory the first time it's requested.
LAZY_WITH_COPY	Image is loaded into memory the first time it's requested.

Method Summary

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

EAGER

public static final PathLoadMode EAGER

Image is immediately loaded into memory.

LAZY

public static final PathLoadMode LAZY

Image is loaded into memory the first time it's requested. Specified path must exist at the time of loading.

LAZY_WITH_COPY

public static final PathLoadMode LAZY_WITH_COPY

Image is loaded into memory the first time it's requested. Specified path is copied into internal directory and so isn't required to exist at the time of loading.

Method Details

values

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