kotlinx-schema-json/kotlinx.schema.json/NumericPropertyDefinition

NumericPropertyDefinition

data class NumericPropertyDefinition(val type: List<String>, val id: String? = null, val anchor: String? = null, val dynamicAnchor: String? = null, val ref: String? = null, val dynamicRef: String? = null, val comment: String? = null, val title: String? = null, val description: String? = null, val nullable: Boolean? = null, val default: JsonElement? = null, val constValue: JsonElement? = null, val defs: Map<String, PropertyDefinition>? = null, val readOnly: Boolean? = null, val writeOnly: Boolean? = null, val deprecated: Boolean? = null, val examples: List<JsonElement>? = null, val oneOf: List<PropertyDefinition>? = null, val anyOf: List<PropertyDefinition>? = null, val allOf: List<PropertyDefinition>? = null, val not: PropertyDefinition? = null, val ifSchema: PropertyDefinition? = null, val thenSchema: PropertyDefinition? = null, val elseSchema: PropertyDefinition? = null, val enum: List<Double>? = null, val multipleOf: Double? = null, val minimum: Double? = null, val exclusiveMinimum: Double? = null, val maximum: Double? = null, val exclusiveMaximum: Double? = null) : ValuePropertyDefinition<Double> , NumericConstraints(source)

Represents a numeric property (integer or number).

Constructors

NumericPropertyDefinition

constructor(type: List<String>, id: String? = null, anchor: String? = null, dynamicAnchor: String? = null, ref: String? = null, dynamicRef: String? = null, comment: String? = null, title: String? = null, description: String? = null, nullable: Boolean? = null, default: JsonElement? = null, constValue: JsonElement? = null, defs: Map<String, PropertyDefinition>? = null, readOnly: Boolean? = null, writeOnly: Boolean? = null, deprecated: Boolean? = null, examples: List<JsonElement>? = null, oneOf: List<PropertyDefinition>? = null, anyOf: List<PropertyDefinition>? = null, allOf: List<PropertyDefinition>? = null, not: PropertyDefinition? = null, ifSchema: PropertyDefinition? = null, thenSchema: PropertyDefinition? = null, elseSchema: PropertyDefinition? = null, enum: List<Double>? = null, multipleOf: Double? = null, minimum: Double? = null, exclusiveMinimum: Double? = null, maximum: Double? = null, exclusiveMaximum: Double? = null)

Properties

open override val allOf: List<PropertyDefinition>?

@SerialName(value = "$anchor")

open override val anchor: String?

open override val anyOf: List<PropertyDefinition>?

@SerialName(value = "$comment")

open override val comment: String?

@SerialName(value = "const")

open override val constValue: JsonElement?

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

open 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")

open override val defs: Map<String, PropertyDefinition>?

open override val deprecated: Boolean?

open override val description: String?

@SerialName(value = "$dynamicAnchor")

open override val dynamicAnchor: String?

@SerialName(value = "$dynamicRef")

open override val dynamicRef: String?

@SerialName(value = "else")

open override val elseSchema: PropertyDefinition?

@Serializable(with = NumericEnumSerializer::class)

val enum: List<Double>?

open override val examples: List<JsonElement>?

exclusiveMaximum

open override val exclusiveMaximum: Double?

exclusiveMinimum

open override val exclusiveMinimum: Double?

@SerialName(value = "$id")

open override val id: String?

@SerialName(value = "if")

open override val ifSchema: PropertyDefinition?

open override val maximum: Double?

open override val minimum: Double?

open override val multipleOf: Double?

open override val not: PropertyDefinition?

open override val nullable: Boolean?

Whether the property can be null.

open override val oneOf: List<PropertyDefinition>?

open override val readOnly: Boolean?

@SerialName(value = "$ref")

open override val ref: String?

@SerialName(value = "then")

open override val thenSchema: PropertyDefinition?

open override val title: String?

@Serializable(with = StringOrListSerializer::class)

open override val type: List<String>

The data type of the property.

open override val writeOnly: Boolean?

Functions

open override fun getTypedConst(): Double?

Returns the const value as a Double, or null if not set or not a number.

getTypedDefault

open override fun getTypedDefault(): Double?

Returns the default value as a Double, or null if not set or not a number.