Module jonix.common

Package com.tectonica.jonix.common.codelist

Enum Class CollectionSequenceTypes

java.lang.Object

java.lang.Enum<CollectionSequenceTypes>

com.tectonica.jonix.common.codelist.CollectionSequenceTypes

All Implemented Interfaces:

OnixCodelist, Serializable, Comparable<CollectionSequenceTypes>, Constable

public enum CollectionSequenceTypes
extends Enum<CollectionSequenceTypes>
implements OnixCodelist

Enum that corresponds to ONIX Codelist 197

Description: Collection sequence type

See Also:

• About ONIX Codelists
• ONIX Codelist 197 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
Original_publication_order	Original publication order, for a republished collection or collected works originally published outside a collection
Proprietary	A short explanatory label for the sequence should be provided in <CollectionSequenceTypeName>
Publication_order	Order of publication of products within the collection
Suggested_display_order	Where it is different from the title order, publication order, narrative order, reading order etc
Suggested_reading_order	Where it is different from the title order, publication order, narrative order etc
Temporal_narrative_order	Order defined by a continuing narrative or temporal sequence within products in the collection.
Title_order	Order as specified by the title, eg by volume or part number sequence, provided for confirmation

Field Summary

Fields

Modifier and Type	Field	Description
final String	code
final String	description

Method Summary

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

Proprietary

public static final CollectionSequenceTypes Proprietary

A short explanatory label for the sequence should be provided in <CollectionSequenceTypeName>

Title_order

public static final CollectionSequenceTypes Title_order

Order as specified by the title, eg by volume or part number sequence, provided for confirmation

Publication_order

public static final CollectionSequenceTypes Publication_order

Order of publication of products within the collection

Temporal_narrative_order

public static final CollectionSequenceTypes Temporal_narrative_order

Order defined by a continuing narrative or temporal sequence within products in the collection. Applicable to either fiction or to non-fiction (eg within a collection of history textbooks)

Original_publication_order

public static final CollectionSequenceTypes Original_publication_order

Original publication order, for a republished collection or collected works originally published outside a collection

Suggested_reading_order

public static final CollectionSequenceTypes Suggested_reading_order

Where it is different from the title order, publication order, narrative order etc

Jonix-Comment: Introduced in Onix3

Suggested_display_order

public static final CollectionSequenceTypes Suggested_display_order

Where it is different from the title order, publication order, narrative order, reading order etc

Jonix-Comment: Introduced in Onix3

Field Details

code

public final String code

description

public final String description

Method Details

values

public static CollectionSequenceTypes[] 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 CollectionSequenceTypes 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 CollectionSequenceTypes byCode(String code)

byCodeOptional

public static Optional<CollectionSequenceTypes> byCodeOptional(String code)

codeToDesciption

public static String codeToDesciption(String code)