kotlinx-schema-json/kotlinx.schema.json/ValuePropertyDefinition

ValuePropertyDefinition

sealed interface ValuePropertyDefinition<out T> : PropertyDefinition, CommonSchemaAttributes, ApplicatorContainer(source)

Represents a value-based property definition in a JSON Schema.

This is a sealed interface that extends from PropertyDefinition and serves as the base for properties that define specific types, such as strings, numbers, arrays, objects, and booleans. Each implementation of this interface allows defining additional type-specific constraints and attributes.

Parameters

T

The native Kotlin type that this property definition represents (e.g., String, Double, Boolean). The type parameter enables type-safe accessors for default and const values while maintaining JSON Schema 2020-12 spec compliance by storing values as JsonElement during serialization.

Inheritors

StringPropertyDefinition

NumericPropertyDefinition

ArrayPropertyDefinition

ObjectPropertyDefinition

BooleanPropertyDefinition

GenericPropertyDefinition

Properties

abstract val allOf: List<PropertyDefinition>?

@SerialName(value = "$anchor")

abstract val anchor: String?

abstract val anyOf: List<PropertyDefinition>?

@SerialName(value = "$comment")

abstract val comment: String?

@SerialName(value = "const")

abstract override val constValue: JsonElement?

Const value as JsonElement (spec-compliant storage). Can be any JSON value per JSON Schema 2020-12 spec.

abstract override val default: JsonElement?

Default value as JsonElement (spec-compliant storage). Can be any JSON value per JSON Schema 2020-12 spec.

@SerialName(value = "$defs")

abstract val defs: Map<String, PropertyDefinition>?

abstract val deprecated: Boolean?

abstract val description: String?

@SerialName(value = "$dynamicAnchor")

abstract val dynamicAnchor: String?

@SerialName(value = "$dynamicRef")

abstract val dynamicRef: String?

abstract val elseSchema: PropertyDefinition?

abstract val examples: List<JsonElement>?

@SerialName(value = "$id")

abstract val id: String?

abstract val ifSchema: PropertyDefinition?

abstract val not: PropertyDefinition?

abstract override val nullable: Boolean?

Whether the property can be null.

abstract val oneOf: List<PropertyDefinition>?

abstract val readOnly: Boolean?

@SerialName(value = "$ref")

abstract val ref: String?

abstract val thenSchema: PropertyDefinition?

abstract val title: String?

abstract override val type: List<String>?

The data type of the property.

abstract val writeOnly: Boolean?

Functions

abstract fun getTypedConst(): T?

Returns the const value converted to the native Kotlin type T. Returns null if the value is null or cannot be converted to type T.

getTypedDefault

abstract fun getTypedDefault(): T?

Returns the default value converted to the native Kotlin type T. Returns null if the value is null or cannot be converted to type T.