Module jonix.onix2

Package com.tectonica.jonix.onix2

Class TextWithDownload

java.lang.Object

com.tectonica.jonix.onix2.TextWithDownload

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Text accompanying download

Unstructured text associated with a file which is available for download, and intended to be displayed whenever the file content is used. Optional and non-repeating. Text may include credits, copyright notice, etc. If this field is sent, the individual elements <DownloadCaption>, <DownloadCredit>, and <DownloadCopyrightNotice> must not be sent, and vice versa.

Format	Variable-length text, suggested maximum length 1,000 characters (XHTML is enabled in this element - see ONIX for Books - Product Information Message - XML Message Specification, Section 7)
Reference name	<TextWithDownload>
Short tag	<f118>

This tag may be included in the following composites:

• <MediaFile>

Possible placements within ONIX message:

• Product ⯈ MediaFile ⯈ TextWithDownload
• Product ⯈ ContentItem ⯈ MediaFile ⯈ TextWithDownload
• Product ⯈ SupplyDetail ⯈ Reissue ⯈ MediaFile ⯈ TextWithDownload

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final TextWithDownload	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 TextWithDownload.

Constructor Summary

Constructors

Constructor	Description
TextWithDownload()
TextWithDownload(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<TextWithDownload> 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 TextWithDownload. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

Raw Format: Variable-length text, suggested maximum length 1,000 characters (XHTML is enabled in this element - see ONIX for Books - Product Information Message - XML Message Specification, Section 7)

(type: XHTML)

EMPTY

public static final TextWithDownload EMPTY

Constructor Details

TextWithDownload

public TextWithDownload()

TextWithDownload

public TextWithDownload(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 (<TextWithDownload> or <f118>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<TextWithDownload> action)