Package org.daisy.dotify.api.formatter

Enum SequenceProperties.SequenceBreakBefore

java.lang.Object

java.lang.Enum<SequenceProperties.SequenceBreakBefore>

org.daisy.dotify.api.formatter.SequenceProperties.SequenceBreakBefore

All Implemented Interfaces:

Serializable, Comparable<SequenceProperties.SequenceBreakBefore>

Enclosing class:

SequenceProperties

public static enum SequenceProperties.SequenceBreakBefore
extends Enum<SequenceProperties.SequenceBreakBefore>

Provides types of "break before" rules for sequences.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	Defines that volume breaks may or may not happen before this sequence begins, depending on its location in the volume.
VOLUME	Specifies that the sequence should start in a new volume.

Method Summary

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

AUTO

public static final SequenceProperties.SequenceBreakBefore AUTO

Defines that volume breaks may or may not happen before this sequence begins, depending on its location in the volume.

VOLUME

public static final SequenceProperties.SequenceBreakBefore VOLUME

Specifies that the sequence should start in a new volume.

Method Detail

values

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

Returns:

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

valueOf

public static SequenceProperties.SequenceBreakBefore 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