kt-schema-generator-core/me.kpavlov.kt.schema.generator.core.ir/Property

Property

data class Property(val name: String, val type: TypeRef, val description: String? = null, val deprecated: Boolean = false, val optional: Boolean = false, val value: PropertyValue = PropertyValue.None, val annotations: Map<String, String?> = emptyMap())(source)

Property of an object.

Constructors

Property

constructor(name: String, type: TypeRef, description: String? = null, deprecated: Boolean = false, optional: Boolean = false, value: PropertyValue = PropertyValue.None, annotations: Map<String, String?> = emptyMap())

Properties

annotations

val annotations: Map<String, String?>

deprecated

val deprecated: Boolean

description

val description: String?

name

val name: String

optional

val optional: Boolean

whether the property may be omitted, as declared by an explicit marker in the source (a Kotlin default value, an optional type-name convention or an optional annotation). A default literal alone does not set it. Ignored for PropertyValue.Const, which is always required.

type

val type: TypeRef

value

val value: PropertyValue

the default or constant attached to the property, if any.

Functions

isPresenceRequired

fun Property.isPresenceRequired(): Boolean

Returns whether this property must be present under the base presence rule: constants always are, otherwise it is unless it is Property.optional or has a known default.