com.levigo.jadice.document.text
Enum Granularity

java.lang.Object
  java.lang.Enum<Granularity>
      com.levigo.jadice.document.text.Granularity

All Implemented Interfaces:

Serializable, Comparable<Granularity>

public enum Granularity
extends Enum<Granularity>

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

Enum Constant Summary

BLOCK

DOCUMENT

GLYPH

LINE

PAGE

WORD

Method Summary

static Granularity	valueOf(String name) Returns the enum constant of this type with the specified name.
static Granularity[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static Granularity[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Granularity c : Granularity.values())
    System.out.println(c);

Returns:

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

valueOf

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