Module jonix.common

Package com.tectonica.jonix.common.struct

Class JonixTitle

java.lang.Object

com.tectonica.jonix.common.struct.JonixTitle

All Implemented Interfaces:

JonixKeyedStruct<TitleTypes>, JonixStruct, Serializable

public class JonixTitle
extends Object
implements JonixKeyedStruct<TitleTypes>, Serializable

This class is a JonixStruct that represents Onix2 <Title>.

It can be retrieved from the composite by invoking its asStruct() method.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	abbreviatedLength	Raw Format: Variable-length integer, suggested maximum 3 digits
static final JonixTitle	EMPTY
String	subtitle	Raw Format: Variable-length text, suggested maximum length 300 characters
TextCaseFlags	textCaseFlag
String	titlePrefix	Raw Format: Variable-length text, suggested maximum length 20 characters
String	titleText	Raw Format: Variable-length text, suggested maximum 300 characters
TitleTypes	titleType	the key of this struct (by which it can be looked up)
String	titleWithoutPrefix	Raw Format: Variable-length text, suggested maximum length 300 characters

Constructor Summary

Constructors

Constructor	Description
JonixTitle()

Method Summary

Modifier and Type	Method	Description
TitleTypes	key()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final JonixTitle EMPTY

titleType

public TitleTypes titleType

the key of this struct (by which it can be looked up)

abbreviatedLength

public String abbreviatedLength

Raw Format: Variable-length integer, suggested maximum 3 digits

(type: NonEmptyString)

textCaseFlag

public TextCaseFlags textCaseFlag

titleText

public String titleText

Raw Format: Variable-length text, suggested maximum 300 characters

(type: NonEmptyString)

titlePrefix

public String titlePrefix

Raw Format: Variable-length text, suggested maximum length 20 characters

(type: NonEmptyString)

titleWithoutPrefix

public String titleWithoutPrefix

Raw Format: Variable-length text, suggested maximum length 300 characters

(type: NonEmptyString)

subtitle

public String subtitle

Raw Format: Variable-length text, suggested maximum length 300 characters

(type: NonEmptyString)

Constructor Details

JonixTitle

public JonixTitle()

Method Details

key

public TitleTypes key()

Specified by:

key in interface JonixKeyedStruct<TitleTypes>