Module jonix.common

Package com.tectonica.jonix.common.codelist

Enum Class InsertPointTypes

java.lang.Object

java.lang.Enum<InsertPointTypes>

com.tectonica.jonix.common.codelist.InsertPointTypes

All Implemented Interfaces:

OnixCodelist, Serializable, Comparable<InsertPointTypes>, Constable

public enum InsertPointTypes
extends Enum<InsertPointTypes>
implements OnixCodelist

Enum that corresponds to ONIX Codelist 255

Description: Insert point type

Jonix-Comment: Introduced in Onix3

See Also:

• About ONIX Codelists
• ONIX Codelist 255 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
Adjacent_to_HTML_label	Insert appears before the block-level HTML element - <InsertPointValue> is the value of the id or name attribute of the block-level element (which must be unique within the body of the product)
Adjacent_to_logical_page	Insert appears after an even numbered or before an odd numbered logical page.
Adjacent_to_physical_page	Insert appears after an even numbered or before an odd numbered printed page number.
At_timecode	Insert appears in the body at a specific timecode (hours, minutes, seconds, counted from the beginning of the product before any inserts are added).

Field Summary

Fields

Modifier and Type	Field	Description
final String	code
final String	description

Method Summary

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

Adjacent_to_logical_page

public static final InsertPointTypes Adjacent_to_logical_page

Insert appears after an even numbered or before an odd numbered logical page. <InsertPointValue> is an integer page number

Adjacent_to_physical_page

public static final InsertPointTypes Adjacent_to_physical_page

Insert appears after an even numbered or before an odd numbered printed page number. <InsertPointValue> is an integer page number

At_timecode

public static final InsertPointTypes At_timecode

Insert appears in the body at a specific timecode (hours, minutes, seconds, counted from the beginning of the product before any inserts are added). <InsertPointValue> is in the format HHHMMSS. Fill with leading zeroes if any elements are missing. If centisecond precision is required, use HHHMMSScc

Adjacent_to_HTML_label

public static final InsertPointTypes Adjacent_to_HTML_label

Insert appears before the block-level HTML element - &lt;InsertPointValue> is the value of the id or name attribute of the block-level element (which must be unique within the body of the product)

Field Details

code

public final String code

description

public final String description

Method Details

values

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

byCodeOptional

public static Optional<InsertPointTypes> byCodeOptional(String code)

codeToDesciption

public static String codeToDesciption(String code)