serialkompat-core/com.chrisjenx.serialkompat.core/Contract

Contract

class Contract(val serialName: String, val kind: ContractKind, elements: List<Element> = emptyList(), enumValues: List<String> = emptyList(), val discriminator: String? = null, subtypes: List<Subtype> = emptyList(), val hasPolymorphicDefault: Boolean = false, val base: String? = null)

The wire contract of a single @Serializable type, identified by its serialName and, for a sealed/polymorphic subtype, the base it was reached through (#200). Collections are normalized to sorted order so that equality and the canonical text form are independent of declaration order.

Which payload is populated depends on kind:

ContractKind.CLASS / ContractKind.OBJECT → elements
ContractKind.ENUM → enumValues
ContractKind.SEALED / ContractKind.POLYMORPHIC → discriminator + subtypes (plus hasPolymorphicDefault for an open ContractKind.POLYMORPHIC base)

Constructors

Contract

constructor(serialName: String, kind: ContractKind, elements: List<Element> = emptyList(), enumValues: List<String> = emptyList(), discriminator: String? = null, subtypes: List<Subtype> = emptyList(), hasPolymorphicDefault: Boolean = false, base: String? = null)

Properties

base

val base: String?

The serial name of the ContractKind.SEALED / ContractKind.POLYMORPHIC contract this contract was reached through as a subtype, or null for a contract reached any other way. A subtype's serial name is only unique within its base, so (serialName, base) is the contract's identity (#200). A subtype of two bases is recorded once per base.

discriminator

val discriminator: String?

elements

val elements: List<Element>

Class elements, sorted by name.

enumValues

val enumValues: List<String>

Enum value names, sorted.

hasPolymorphicDefault

val hasPolymorphicDefault: Boolean

Whether an open ContractKind.POLYMORPHIC base registered a default deserializer in its SerializersModule. That fallback lets a reader coerce an unknown (e.g. newly-added) subtype's discriminator to a sentinel instead of throwing, which downgrades an added-subtype forward break to a WARN (#128). Always false for closed/sealed and non-polymorphic contracts.

kind

val kind: ContractKind

qualifiedName

val qualifiedName: String

The contract's display identity: Base/sub for a subtype, else the bare serialName. Used in findings and accepted by renames, accepted breaks, and Scope.

serialName

val serialName: String

subtypes

val subtypes: List<Subtype>

Sealed/polymorphic subtypes, sorted by discriminator value.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String