Module jonix.onix2

Package com.tectonica.jonix.onix2

Class DownloadCaption

java.lang.Object

com.tectonica.jonix.onix2.DownloadCaption

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Download caption

Text of a caption associated with a download file, and intended to be displayed whenever the file content is used. Optional and non-repeating. The <DownloadCaption> element may be sent together with either or both of fields <DownloadCredit>, or <DownloadCopyrightNotice>.

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

This tag may be included in the following composites:

• <MediaFile>

Possible placements within ONIX message:

• Product ⯈ MediaFile ⯈ DownloadCaption
• Product ⯈ ContentItem ⯈ MediaFile ⯈ DownloadCaption
• Product ⯈ SupplyDetail ⯈ Reissue ⯈ MediaFile ⯈ DownloadCaption

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DownloadCaption()
DownloadCaption(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<DownloadCaption> 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 DownloadCaption. 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 500 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 DownloadCaption EMPTY

Constructor Details

DownloadCaption

public DownloadCaption()

DownloadCaption

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

ifExists

public void ifExists(Consumer<DownloadCaption> action)