serialkompat-core/com.chrisjenx.serialkompat.core/Element

Element

class Element(val name: String, val type: String, val optional: Boolean = false, val nullable: Boolean = false, jsonNames: List<String> = emptyList(), val encodeDefault: EncodeDefaultMode? = null)

A single element (field) of a ContractKind.CLASS contract, recording the compatibility-bearing facts about how it appears on the JSON wire.

jsonNames is normalized to sorted order so that equality is independent of annotation declaration order.

Constructors

Element

constructor(name: String, type: String, optional: Boolean = false, nullable: Boolean = false, jsonNames: List<String> = emptyList(), encodeDefault: EncodeDefaultMode? = null)

Properties

encodeDefault

val encodeDefault: EncodeDefaultMode?

the field's @EncodeDefault mode (EncodeDefaultMode.ABSENT when verified to carry none), or null when it was not recorded and is therefore unknown (#158).

jsonNames

val jsonNames: List<String>

additional accepted input keys from @JsonNames.

name

val name: String

the JSON key, post-@SerialName and post-namingStrategy.

nullable

val nullable: Boolean

whether the element accepts a JSON null.

optional

val optional: Boolean

whether the element may be omitted from the wire — straight from SerialDescriptor.isElementOptional, never re-derived.