org.daisy.dotify.api.formatter

Enum TransitionBuilderProperties.ApplicationRange

java.lang.Object

java.lang.Enum<TransitionBuilderProperties.ApplicationRange>

org.daisy.dotify.api.formatter.TransitionBuilderProperties.ApplicationRange

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TransitionBuilderProperties.ApplicationRange>

Enclosing class:

TransitionBuilderProperties

public static enum TransitionBuilderProperties.ApplicationRange
extends java.lang.Enum<TransitionBuilderProperties.ApplicationRange>

Defines the application range starting from the end of the volume. Within this range, pages may be treated differently from pages elsewhere.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE All pages are treated the same
PAGE The last page may be treated differently
SHEET The last sheet may be treated differently

Method Summary

Modifier and Type	Method and Description
static TransitionBuilderProperties.ApplicationRange	parse(java.lang.String value) Parses a string as a TransitionBuilderProperties.ApplicationRange.
static TransitionBuilderProperties.ApplicationRange	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TransitionBuilderProperties.ApplicationRange[]	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

NONE

public static final TransitionBuilderProperties.ApplicationRange NONE

All pages are treated the same

PAGE

public static final TransitionBuilderProperties.ApplicationRange PAGE

The last page may be treated differently

SHEET

public static final TransitionBuilderProperties.ApplicationRange SHEET

The last sheet may be treated differently

Method Detail

values

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

Returns:

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

valueOf

public static TransitionBuilderProperties.ApplicationRange 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

parse

public static TransitionBuilderProperties.ApplicationRange parse(java.lang.String value)

Parses a string as a TransitionBuilderProperties.ApplicationRange. There is a small difference of this method compared to calling valueOf(String) is that it is case insensitive (since all enum members contain upper case letters only).

Parameters:

value - the string value

Returns:

returns the range

Throws:

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