kform/tech.ostack.kform.schemas/FileSchema

FileSchema

open class FileSchema(validations: Iterable<Validation<File>> = emptyList(), val initialValue: File = emptyPlaceholderFile()) : AbstractSimpleSchema<File> (source)

Schema representing values of type File.

Constructors

FileSchema

constructor(vararg validations: Validation<File>, initialValue: File = emptyPlaceholderFile())

constructor(validations: Iterable<Validation<File>> = emptyList(), initialValue: File = emptyPlaceholderFile())

Properties

initialValue

open override val initialValue: File

Initial value for a value of this schema.

typeInfo

open override val typeInfo: TypeInfo

Information about the type of value represented by this schema.

validations

open override val validations: List<Validation<File>>

List of validations used to validate this schema.

Functions

assignableTo

open override fun assignableTo(type: KType): Boolean

Whether a value of this schema can be assigned to a variable with the provided type.

change

open suspend override fun change(path: AbsolutePath, value: File, intoValue: Any?, eventsBus: SchemaEventsBus, setValue: suspend (value: File) -> Unit)

Changes value, a value of this schema stored by the form manager into the given value intoValue, sending events about the change through eventsBus. The provided path represents the path of the value being changed within the form manager. The value must be set via setValue, even if it hasn't changed; for parent schemas, it should typically be the same instance of value, but mutated to resemble intoValue.

clone

open suspend override fun clone(value: File): File

Returns a clone (deep copy) of value.

comparePaths

fun Schema<*>.comparePaths(path1: String, path2: String): Int

fun Schema<*>.comparePaths(path1: Path, path2: Path): Int

Compares two paths of a schema according to the order in which children are defined in said schema. Returns a value > 0 if path1 is greater than path2, < 0 if path2 if greater than path1, or 0 otherwise.

destroy

open suspend override fun destroy(path: AbsolutePath, value: File, eventsBus: SchemaEventsBus, removeValue: suspend (value: File) -> Unit)

Destroys and removes value, a value of this schema stored by the form manager, sending events about the destruction through eventsBus. The provided path represents the path of the value being destroyed within the form manager. removeValue should always be called to remove the value.

fromAny

open suspend fun fromAny(value: Any?): File

init

open suspend override fun init(path: AbsolutePath, fromValue: Any?, eventsBus: SchemaEventsBus, setValue: suspend (value: File) -> Unit)

Initialises and sets a value of this schema from a given value fromValue to be stored by the form manager, sending events about the initialisation of the value through eventsBus. The provided path represents the path of the value being initialised within the form manager. The value must be set via setValue, which should always be called.