Package com.levigo.jadice.document.text

Enum Class Granularity

java.lang.Object

java.lang.Enum<Granularity>

com.levigo.jadice.document.text.Granularity

All Implemented Interfaces:

Serializable, Comparable<Granularity>, Constable

public enum Granularity
extends Enum<Granularity>

An enum listing the text content element levels. Used to indicate a granularity level for selection operations.

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
BLOCK
DOCUMENT
GLYPH
LINE
PAGE
WORD

Method Summary

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

GLYPH

public static final Granularity GLYPH

WORD

public static final Granularity WORD

LINE

public static final Granularity LINE

BLOCK

public static final Granularity BLOCK

PAGE

public static final Granularity PAGE

DOCUMENT

public static final Granularity DOCUMENT

Method Details

values

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