kotlinx-schema-json/kotlinx.schema.json/BooleanPropertyDefinition

BooleanPropertyDefinition

data class BooleanPropertyDefinition(val type: List<String> = BOOLEAN_TYPE, 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<Boolean>? = null) : ValuePropertyDefinition<Boolean> (source)

Represents a boolean property

Constructors

BooleanPropertyDefinition

constructor(type: List<String> = BOOLEAN_TYPE, 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<Boolean>? = 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 = BooleanEnumSerializer::class)

val enum: List<Boolean>?

open override val examples: List<JsonElement>?

@SerialName(value = "$id")

open override val id: String?

@SerialName(value = "if")

open override val ifSchema: PropertyDefinition?

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(): Boolean?

Returns the const value as a Boolean, or null if not set or not a boolean.

getTypedDefault

open override fun getTypedDefault(): Boolean?

Returns the default value as a Boolean, or null if not set or not a boolean.