Package io.scanbot.sdk.image

Enum Class ImageOrigin

java.lang.Object

java.lang.Enum<ImageOrigin>

io.scanbot.sdk.image.ImageOrigin

All Implemented Interfaces:

Serializable, Comparable<ImageOrigin>, Constable

public enum ImageOrigin
extends Enum<ImageOrigin>

Location of the image origin in the image coordinate system.

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
BOTTOM_LEFT	Origin is at the bottom left corner of the image.
BOTTOM_RIGHT	Origin is at the bottom right corner of the image.
TOP_LEFT	Origin is at the top left corner of the image.
TOP_RIGHT	Origin is at the top right corner of the image.

Method Summary

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

TOP_LEFT

public static final ImageOrigin TOP_LEFT

Origin is at the top left corner of the image.

TOP_RIGHT

public static final ImageOrigin TOP_RIGHT

Origin is at the top right corner of the image.

BOTTOM_LEFT

public static final ImageOrigin BOTTOM_LEFT

Origin is at the bottom left corner of the image.

BOTTOM_RIGHT

public static final ImageOrigin BOTTOM_RIGHT

Origin is at the bottom right corner of the image.

Method Details

values

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