Module jonix.common

Package com.tectonica.jonix.common.codelist

Enum Class BibleReferenceLocations

java.lang.Object

java.lang.Enum<BibleReferenceLocations>

com.tectonica.jonix.common.codelist.BibleReferenceLocations

All Implemented Interfaces:

OnixCodelist, Serializable, Comparable<BibleReferenceLocations>, Constable

public enum BibleReferenceLocations
extends Enum<BibleReferenceLocations>
implements OnixCodelist

Enum that corresponds to ONIX Codelist 87

Description: Bible reference location

See Also:

• About ONIX Codelists
• ONIX Codelist 87 in Reference Guide

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface com.tectonica.jonix.common.OnixCodelist

OnixCodelist.Pair

Enum Constant Summary

Enum Constants

Enum Constant	Description
Center_column	References are printed in a narrow column in the center of the page between two columns of text
Other	Other locations not otherwise identified
Page_end	References are printed at the foot of the page
Side_column	References are printed in a column to the side of the scripture
Unknown	The person creating the ONIX record does not know where the references are located
Verse_end	References are printed at the end of the applicable verse

Field Summary

Fields

Modifier and Type	Field	Description
final String	code
final String	description

Method Summary

Modifier and Type	Method	Description
static BibleReferenceLocations	byCode(String code)
static Optional<BibleReferenceLocations>	byCodeOptional(String code)
static String	codeToDesciption(String code)
String	getCode()
String	getDescription()
static BibleReferenceLocations	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BibleReferenceLocations[]	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

Methods inherited from interface com.tectonica.jonix.common.OnixCodelist

pair

Enum Constant Details

Center_column

public static final BibleReferenceLocations Center_column

References are printed in a narrow column in the center of the page between two columns of text

Page_end

public static final BibleReferenceLocations Page_end

References are printed at the foot of the page

Side_column

public static final BibleReferenceLocations Side_column

References are printed in a column to the side of the scripture

Verse_end

public static final BibleReferenceLocations Verse_end

References are printed at the end of the applicable verse

Unknown

public static final BibleReferenceLocations Unknown

The person creating the ONIX record does not know where the references are located

Other

public static final BibleReferenceLocations Other

Other locations not otherwise identified

Field Details

code

public final String code

description

public final String description

Method Details

values

public static BibleReferenceLocations[] 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 BibleReferenceLocations 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

getCode

public String getCode()

Specified by:

getCode in interface OnixCodelist

getDescription

public String getDescription()

Specified by:

getDescription in interface OnixCodelist

byCode

public static BibleReferenceLocations byCode(String code)

byCodeOptional

public static Optional<BibleReferenceLocations> byCodeOptional(String code)

codeToDesciption

public static String codeToDesciption(String code)