Module jonix.common

Package com.tectonica.jonix.common.codelist

Enum Class PersonOrganizationNameTypes

java.lang.Object

java.lang.Enum<PersonOrganizationNameTypes>

com.tectonica.jonix.common.codelist.PersonOrganizationNameTypes

All Implemented Interfaces:

OnixCodelist, Serializable, Comparable<PersonOrganizationNameTypes>, Constable

public enum PersonOrganizationNameTypes
extends Enum<PersonOrganizationNameTypes>
implements OnixCodelist

Enum that corresponds to ONIX Codelist 18

Description: Person / organization name type

See Also:

• About ONIX Codelists
• ONIX Codelist 18 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
Authority_controlled_name
Earlier_name	Use only within <AlternativeName>
Fictional_character_name	Use only within <NameAsSubject> to indicate the subject is fictional, or in <AlternativeName> alongside <UnnamedPersons> to indicate a human-like name for a synthetic voice or AI.
Later_name	Use only within <AlternativeName>
Pseudonym	May be used to give a well-known pseudonym, where the primary name is a 'real' name
Real_name	May be used to identify a well-known real name, where the primary name is a pseudonym
Transliterated_translated_form_of_primary_name	Use only within <AlternativeName>, when the primary name type is unspecified, for names in a different script or language
Unspecified	Usually the name as it is presented on the book

Field Summary

Fields

Modifier and Type	Field	Description
final String	code
final String	description

Method Summary

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

Unspecified

public static final PersonOrganizationNameTypes Unspecified

Usually the name as it is presented on the book

Pseudonym

public static final PersonOrganizationNameTypes Pseudonym

May be used to give a well-known pseudonym, where the primary name is a 'real' name

Authority_controlled_name

public static final PersonOrganizationNameTypes Authority_controlled_name

Earlier_name

public static final PersonOrganizationNameTypes Earlier_name

Use only within <AlternativeName>

Real_name

public static final PersonOrganizationNameTypes Real_name

May be used to identify a well-known real name, where the primary name is a pseudonym

Transliterated_translated_form_of_primary_name

public static final PersonOrganizationNameTypes Transliterated_translated_form_of_primary_name

Use only within <AlternativeName>, when the primary name type is unspecified, for names in a different script or language

Later_name

public static final PersonOrganizationNameTypes Later_name

Use only within <AlternativeName>

Fictional_character_name

public static final PersonOrganizationNameTypes Fictional_character_name

Use only within <NameAsSubject> to indicate the subject is fictional, or in <AlternativeName> alongside <UnnamedPersons> to indicate a human-like name for a synthetic voice or AI. Only for use in ONIX 3.0 or later

Jonix-Comment: Introduced in Onix3

Field Details

code

public final String code

description

public final String description

Method Details

values

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

byCodeOptional

public static Optional<PersonOrganizationNameTypes> byCodeOptional(String code)

codeToDesciption

public static String codeToDesciption(String code)