io.quarkus.hibernate.orm.panache.kotlin.PanacheEntityBase.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-hibernate-orm-panache-kotlin Show documentation

Define your persistent model in Hibernate ORM with Panache

There is a newer version: 3.17.0.CR1

Show newest version

package io.quarkus.hibernate.orm.panache.kotlin

import com.fasterxml.jackson.annotation.JsonIgnore
import io.quarkus.hibernate.orm.panache.kotlin.runtime.KotlinJpaOperations.Companion.INSTANCE
import jakarta.json.bind.annotation.JsonbTransient

/**
 * Represents an entity. If your Hibernate entities extend this class they gain auto-generated
 * accessors to all their public fields (unless annotated with [Transient]), as well as a lot of
 * useful methods. Unless you have a custom ID strategy, you should not extend this class directly
 * but extend [PanacheEntity] instead.
 *
 * @see [PanacheEntity]
 */
interface PanacheEntityBase {
    // Operations

    /**
     * Returns true if this entity is persistent in the database. If yes, all modifications to its
     * persistent fields will be automatically committed to the database at transaction commit time.
     *
     * @return true if this entity is persistent in the database.
     */
    @JsonbTransient @JsonIgnore fun isPersistent(): Boolean = INSTANCE.isPersistent(this)

    /**
     * Persist this entity in the database, if not already persisted. This will set your ID field if
     * it is not already set.
     *
     * @see [PanacheEntityBase.isPersistent]
     * @see [PanacheEntityBase.flush]
     * @see [PanacheEntityBase.persistAndFlush]
     */
    fun persist() {
        INSTANCE.persist(this)
    }

    /**
     * Persist this entity in the database, if not already persisted. This will set your ID field if
     * it is not already set. Then flushes all pending changes to the database.
     *
     * @see [PanacheEntityBase.isPersistent]
     * @see [PanacheEntityBase.flush]
     * @see [PanacheEntityBase.persist]
     */
    fun persistAndFlush() {
        INSTANCE.persist(this)
        INSTANCE.flush(this)
    }

    /**
     * Delete this entity from the database, if it is already persisted.
     *
     * @see [PanacheEntityBase.isPersistent]
     * @see [PanacheCompanion.deleteAll]
     */
    fun delete() {
        INSTANCE.delete(this)
    }
}