core/net.zagart.keystone.annotations

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD])

@SerialInfo

annotation class Embedded(val prefix: String = "")

Annotation to mark a property as an embedded object. The fields of the embedded object will be stored in the same scope as the parent entity.

Entity

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Entity(val type: String = "")

Annotation to mark a class as a Keystone entity.

EntityAdapter

interface EntityAdapter<T>

Interface for adapters that handle the mapping between domain entities and Keystone storage structures.

InternalKeystoneApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This is an internal Keystone API that should not be used from outside of the library. It may change without notice.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class InternalKeystoneApi

Marks declarations that are internal to the Keystone library and should not be used from outside of the library. Using such APIs will result in a compilation error.

Key

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD])

annotation class Key

Annotation to mark a property as the unique identifier for a Keystone entity.