Module jonix.onix2

Package com.tectonica.jonix.onix2

Class MessageNote

java.lang.Object

com.tectonica.jonix.onix2.MessageNote

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

public class MessageNote
extends Object
implements OnixElement<String>, Serializable

Message note

Free text giving additional information about the message. Optional and non-repeating.

The text is not limited to ASCII characters.

Format	Variable-length ASCII text, suggested maximum 500 characters
Reference name	<MessageNote>
Short tag	<m183>
Example	<MessageNote>Updates for titles to be published September 2000</MessageNote>

This tag may be included in the following composites:

• <Header>

Possible placements within ONIX message:

• Header ⯈ MessageNote

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final MessageNote	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration
String	value	This is the raw content of MessageNote.

Constructor Summary

Constructors

Constructor	Description
MessageNote()
MessageNote(Element element)

Method Summary

Modifier and Type	Method	Description
String	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<MessageNote> action)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

equal, is, isNull, value

Field Details

refname

public static final String refname

See Also:

• Constant Field Values

shortname

public static final String shortname

See Also:

• Constant Field Values

textformat

public TextFormats textformat

textcase

public TextCaseFlags textcase

language

public Languages language

transliteration

public TransliterationSchemes transliteration

datestamp

public String datestamp

(type: DateOrDateTime)

sourcetype

public RecordSourceTypes sourcetype

sourcename

public String sourcename

value

public String value

This is the raw content of MessageNote. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

Raw Format: Variable-length ASCII text, suggested maximum 500 characters

(type: NonEmptyString)

EMPTY

public static final MessageNote EMPTY

Constructor Details

MessageNote

public MessageNote()

MessageNote

public MessageNote(Element element)

Method Details

__v

public String __v()

Internal API, use the OnixElement.value() method or the OnixElement.value() field instead

Specified by:

__v in interface OnixElement<String>

exists

public boolean exists()

Description copied from interface: OnixTag

indicates whether this tag exists in the ONIX record

Specified by:

exists in interface OnixTag

Returns:

whether this tag (<MessageNote> or <m183>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<MessageNote> action)