Package at.bestsolution.uia

Enum Class TextUnit

java.lang.Object

java.lang.Enum<TextUnit>

at.bestsolution.uia.TextUnit

All Implemented Interfaces:

INativeEnum, Serializable, Comparable<TextUnit>, Constable

public enum TextUnit
extends Enum<TextUnit>
implements INativeEnum

Contains values that specify units of text for the purposes of navigation.

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
Character	Character.
Document	Document.
Format	Format.
Line	Line.
Page	Page.
Paragraph	Paragraph.
Word	Word.

Method Summary

Modifier and Type	Method	Description
static Optional<TextUnit>	fromNativeValue(int nativeValue)
String	getConstantName()
int	getNativeValue()
static TextUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TextUnit[]	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

Character

public static final TextUnit Character

Character.

Format

public static final TextUnit Format

Format.

Word

public static final TextUnit Word

Word.

Line

public static final TextUnit Line

Line.

Paragraph

public static final TextUnit Paragraph

Paragraph.

Page

public static final TextUnit Page

Page.

Document

public static final TextUnit Document

Document.

Method Details

values

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

getNativeValue

public int getNativeValue()

Specified by:

getNativeValue in interface INativeEnum

getConstantName

public String getConstantName()

Specified by:

getConstantName in interface INativeEnum

fromNativeValue

public static Optional<TextUnit> fromNativeValue(int nativeValue)