kotlinx.dnq.java.time.InstantProperty.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-8-time Show documentation
Data definition and queries Kotlin DSL over Xodus
The newest version!
/**
 * Copyright 2006 - 2022 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package kotlinx.dnq.java.time

import jetbrains.exodus.bindings.IntegerBinding
import jetbrains.exodus.bindings.LongBinding
import jetbrains.exodus.util.LightOutputStream
import kotlinx.dnq.XdEntity
import kotlinx.dnq.simple.*
import kotlinx.dnq.simple.custom.type.XdCustomTypeBinding
import java.io.ByteArrayInputStream
import java.time.Instant

object InstantBinding : XdCustomTypeBinding() {

    override val clazz = Instant::class.java

    override fun write(stream: LightOutputStream, value: Instant) {
        LongBinding.BINDING.writeObject(stream, value.epochSecond)
        IntegerBinding.BINDING.writeObject(stream, value.nano)
    }

    override fun read(stream: ByteArrayInputStream): Instant {
        val epochSeconds = LongBinding.BINDING.readObject(stream)
        val nano = IntegerBinding.BINDING.readObject(stream).toLong()
        return Instant.ofEpochSecond(epochSeconds, nano)
    }

    override fun min(): Instant = Instant.MIN
    override fun max(): Instant = Instant.MAX
    override fun prev(value: Instant): Instant = value.minusNanos(1)
    override fun next(value: Instant): Instant = value.plusNanos(1)
}

/**
 * Gets from cache or creates a new property delegate for primitive persistent property of type `java.time.Instant?`.
 *
 * If persistent property value is not defined in database the property returns `null`.
 *
 * **Sample**: optional nullable Instant property with database name `createdAt`.
 * ```
 * var createdAt by xdInstantProp()
 * ```
 *
 * @param dbName name of persistent property in database. If `null` (by default) then name of the related
 *        Kotlin-property is used as the name of the property in the database.
 * @param constraints closure that has `PropertyConstraintsBuilder` as a receiver. Enables set up of property
 *        constraints that will be checked before transaction flush.
 * @return property delegate to access Xodus database persistent property using Kotlin-property.
 * @see isAfter()
 * @see isBefore()
 */
fun  xdInstantProp(dbName: String? = null, constraints: Constraints? = null) =
        xdNullableCachedProp(dbName, InstantBinding, constraints)

/**
 * Gets from cache or creates a new property delegate for primitive persistent property of type `java.time.Instant`.
 *
 * Related persistent property is required, i.e. Xodus-DNQ checks on flush that property value is defined.
 *
 * While persistent property value is not defined in database the property throws `RequiredPropertyUndefinedException` on get.
 *
 * **Sample**: required not-null Instant property with database name `createdAt`.
 * ```
 * var createdAt by xdRequiredInstantProp()
 * ```
 *
 * @param unique if `true` Xodus-DNQ checks on flush uniqueness of the property value among instances of
 *        the persistent class. By default is `false`.
 * @param dbName name of persistent property in database. If `null` (by default) then name of the related
 *        Kotlin-property is used as the name of the property in the database.
 * @param constraints closure that has `PropertyConstraintsBuilder` as a receiver. Enables set up of property
 *        constraints that will be checked before transaction flush.
 * @return property delegate to access Xodus database persistent property using Kotlin-property.
 * @see isAfter()
 * @see isBefore()
 */
fun  xdRequiredInstantProp(unique: Boolean = false, dbName: String? = null, constraints: Constraints? = null) =
        xdCachedProp(dbName, constraints, true, unique, InstantBinding, DEFAULT_REQUIRED)