Value Object Property

Contains another DataModel as a fixed-size value. See DataModels for more details on how to define DataModels.

ValueDataModel objects are stored and transported as fixed length byte objects. This makes them usable as map keys and list/set items.

• Kotlin Definition: ValueObjectDefinition<T> T is for the name of DataModel
• Kotlin Value: T T stands for the data class which extends ValueDataObject; its companion defines the ValueDataModel
• Maryk Yaml Definition: Value

Usage options

• Value
• Map key or value
• Inside List/Set

Validation Options

• required - default true
• final - default false

Other options

• default - the default value to be used if value was not set.
• dataModel - Refers to DataModel to be used as value

Examples

Example of a Value Object property definition for use within a Model

val arrivalTime by valueObject(
    index = 1u,
    required = false,
    final = true,
    dataModel = PersonRoleInPeriod
)

Example of a separate ValueObject property definition

val def = ValueObjectDefinition(
    required = false,
    final = true,
    dataModel = PersonRoleInPeriod
)

Storage/Transport Byte representation

Each property of the value model is stored in its representative byte format. All values are combined into one array separated by a separator byte (0b0001) in the order of how the properties are defined.

Readers require each separator to be exactly 0x01 and reject invalid markers.

Generated value objects check that supplied values match their packed bytes. Their cached fields are decoded at storage precision, and returned value slots are independent snapshots. Editing a returned slot cannot change the object.

With transport the field is encoded as length delimited wire type preceded by length of bytes