Package org.daisy.dotify.api.formatter

Enum ItemSequenceProperties.Range

java.lang.Object

java.lang.Enum<ItemSequenceProperties.Range>

org.daisy.dotify.api.formatter.ItemSequenceProperties.Range

All Implemented Interfaces:

Serializable, Comparable<ItemSequenceProperties.Range>

Enclosing class:

ItemSequenceProperties

public static enum ItemSequenceProperties.Range
extends Enum<ItemSequenceProperties.Range>

Defines ranges.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOCUMENT	Defines the range to include the entire document.
VOLUME	Defines the range to include entries within the volume.

Method Summary

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

DOCUMENT

public static final ItemSequenceProperties.Range DOCUMENT

Defines the range to include the entire document.

VOLUME

public static final ItemSequenceProperties.Range VOLUME

Defines the range to include entries within the volume.

Method Detail

values

public static ItemSequenceProperties.Range[] 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 (ItemSequenceProperties.Range c : ItemSequenceProperties.Range.values())
    System.out.println(c);

Returns:

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

valueOf

public static ItemSequenceProperties.Range 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