org.daisy.dotify.api.formatter

Enum TocProperties.TocRange

java.lang.Object

java.lang.Enum<TocProperties.TocRange>

org.daisy.dotify.api.formatter.TocProperties.TocRange

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TocProperties.TocRange>

Enclosing class:

TocProperties

public static enum TocProperties.TocRange
extends java.lang.Enum<TocProperties.TocRange>

Defines TOC ranges.

Enum Constant Summary

Enum Constants

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

Method Summary

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

Defines the TOC range to include the entire document

VOLUME

public static final TocProperties.TocRange VOLUME

Defines the TOC range to include entries within the volume

Method Detail

values

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

Returns:

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

valueOf

public static TocProperties.TocRange valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null