tech.simter.kv.impl.dao.jpa.KeyValueBlockDao.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simter-kv-dao-jpa Show documentation

Dao Implementation By JPA

The newest version!

package tech.simter.kv.impl.dao.jpa

import java.util.*

/**
 * The Key-Value block Dao Interface.
 *
 * @author RJ
 */
interface KeyValueBlockDao {
  /**
   * Retrieves a value by key.
   *
   * @param[key] the key
   * @return [Optional] with the value if key exists or [Optional.empty] otherwise.
   */
  fun valueOf(key: String): Optional

  /**
   * Find all key-value pairs by keys.
   *
   * @param[keys] the keys
   * @return key-value pairs store in a map if at lease one key exists or empty [Map] otherwise.
   */
  fun find(vararg keys: String): Map

  /**
   * Create or update key-value pairs.
   *
   * Update the value if key exists or create a new key-value pair otherwise .
   *
   * @param[keyValues] the key-value pairs to save or update
   */
  fun save(keyValues: Map)

  /**
   * Delete key-value pairs by key.
   *
   * @param[keys] the keys to delete
   */
  fun delete(vararg keys: String)
}