← Back to Stormify Documentation

stormify/onl.ycode.stormify/PropertyMeta

PropertyMeta

class PropertyMeta<T : Any>(val name: String, val type: KClass<*>, val isReference: Boolean, val getter: (T) -> Any?, val setter: (T, Any?, Stormify) -> Unit, val dbNameOverride: String?, val isPrimaryKey: Boolean, val sequence: String?, val isAutoIncrement: Boolean = false, val isCreatable: Boolean = true, val isUpdatable: Boolean = true, val isTransient: Boolean = false, val isEnum: Boolean = false, val enumAsString: Boolean = false)

Describes a single property of an entity class, including its type, getter/setter lambdas, and database mapping overrides. Used by EntityMeta and the annotation processor.

Constructors

constructor(name: String, type: KClass<*>, isReference: Boolean, getter: (T) -> Any?, setter: (T, Any?, Stormify) -> Unit, dbNameOverride: String?, isPrimaryKey: Boolean, sequence: String?, isAutoIncrement: Boolean = false, isCreatable: Boolean = true, isUpdatable: Boolean = true, isTransient: Boolean = false, isEnum: Boolean = false, enumAsString: Boolean = false)

Properties

val dbNameOverride: String?

explicit database column name, or null to use the NamingPolicy

val enumAsString: Boolean

whether enum values are stored as their string name (true) or ordinal/custom integer (false)

val getter: (T) -> Any?

lambda to read the property value from an entity instance

isAutoIncrement

val isAutoIncrement: Boolean

whether the database auto-generates this value (IDENTITY columns)

val isCreatable: Boolean

whether this property is included in INSERT statements

val isEnum: Boolean

whether the property type is a Kotlin/Java enum

val isPrimaryKey: Boolean

whether this property is part of the primary key

val isReference: Boolean

whether this property is a foreign key reference to another entity

val isTransient: Boolean

whether this property should be excluded from all database operations

val isUpdatable: Boolean

whether this property is included in UPDATE statements

val name: String

the Kotlin property name

val sequence: String?

the database sequence name for auto-generation, or null

val setter: (T, Any?, Stormify) -> Unit

lambda to write a value into the property, with type conversion via Stormify

val type: KClass<*>

the property's Kotlin type