Package com.tyndalehouse.step.core.models

Enum Class InterlinearMode

java.lang.Object

java.lang.Enum<InterlinearMode>

com.tyndalehouse.step.core.models.InterlinearMode

All Implemented Interfaces:

Serializable, Comparable<InterlinearMode>, Constable

public enum InterlinearMode
extends Enum<InterlinearMode>

Indicates the output required by the user, interleaving, column view or interlinear. Interleaving and column views also support difference checking

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COLUMN	Column view, where each verse is lined up with the others
COLUMN_COMPARE	Column view with compare options
INTERLEAVED	interleaving one or more versions with each other
INTERLEAVED_COMPARE	Interleaving but also having the differences in each text shown
INTERLINEAR	Tradition interlinear, only works for tagged texts
NONE	no interlinear desired

Method Summary

Modifier and Type	Method	Description
static InterlinearMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InterlinearMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INTERLINEAR

public static final InterlinearMode INTERLINEAR

Tradition interlinear, only works for tagged texts

INTERLEAVED

public static final InterlinearMode INTERLEAVED

interleaving one or more versions with each other

INTERLEAVED_COMPARE

public static final InterlinearMode INTERLEAVED_COMPARE

Interleaving but also having the differences in each text shown

COLUMN

public static final InterlinearMode COLUMN

Column view, where each verse is lined up with the others

COLUMN_COMPARE

public static final InterlinearMode COLUMN_COMPARE

Column view with compare options

NONE

public static final InterlinearMode NONE

no interlinear desired

Method Details

values

public static InterlinearMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static InterlinearMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null