Package com.azure.ai.formrecognizer.models

Enum LengthUnit

java.lang.Object

java.lang.Enum<LengthUnit>

com.azure.ai.formrecognizer.models.LengthUnit

All Implemented Interfaces:

Serializable, Comparable<LengthUnit>, java.lang.constant.Constable

public enum LengthUnit
extends Enum<LengthUnit>

The unit used by the width, height and boundingBox properties. For images, the unit is "pixel". For PDF, the unit is "inch".

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
INCH	Enum value inch.
PIXEL	Enum value pixel.

Method Summary

Modifier and Type	Method	Description
static LengthUnit	fromString(String value)	Parses a serialized value to a LengthUnit instance.
String	toString()
static LengthUnit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LengthUnit[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PIXEL

public static final LengthUnit PIXEL

Enum value pixel.

INCH

public static final LengthUnit INCH

Enum value inch.

Method Details

values

public static LengthUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LengthUnit valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static LengthUnit fromString(String value)

Parses a serialized value to a LengthUnit instance.

Parameters:

value - the serialized value to parse.

Returns:

the parsed LengthUnit object, or null if unable to parse.

toString

public String toString()

Overrides:

toString in class Enum<LengthUnit>