jakarta.nosql.mapping.keyvalue

Interface KeyValueTemplate

public interface KeyValueTemplate

This interface that represents the common operation between an entity and KeyValueEntity

Method Summary

Modifier and Type	Method and Description
<K> void	delete(Iterable<K> keys) Removes entities from keys
<K> void	delete(K key) Removes an entity from key
<K,T> Iterable<T>	get(Iterable<K> keys, Class<T> entityClass) Finds a list of values from keys
<K,T> Optional<T>	get(K key, Class<T> entityClass) Finds the Value from a key
<T> Optional<T>	getSingleResult(String query, Class<T> entityClass) Executes query in the database then returns as single result
<T> PreparedStatement	prepare(String query, Class<T> entityClass) Executes query with PreparedStatement
default <T> Iterable<T>	put(Iterable<T> entities) Saves the Iterable of entities
default <T> Iterable<T>	put(Iterable<T> entities, Duration ttl) Saves the Iterable of entities with a defined time to live
<T> T	put(T entity) Saves the entity
<T> T	put(T entity, Duration ttl) Saves the entity with time to live
void	query(String query) Executes query in the database and don't return result, e.g.: when the query is either remove or put
<T> Stream<T>	query(String query, Class<T> entityClass) Executes query in the database

Method Detail

put

<T> T put(T entity)

Saves the entity

Type Parameters:

T - the entity type

Parameters:

entity - the entity to be insert

Returns:

the entity

Throws:

NullPointerException - when entity is null

put

<T> T put(T entity,
          Duration ttl)

Saves the entity with time to live

Type Parameters:

T - the entity type

Parameters:

entity - the entity to be insert

ttl - the defined time to live

Returns:

the entity

Throws:

NullPointerException - when entity is null

UnsupportedOperationException - when expired time is not supported

put

default <T> Iterable<T> put(Iterable<T> entities)

Saves the Iterable of entities

Type Parameters:

T - the entity type

Parameters:

entities - keys to be insert

Returns:

the entities

Throws:

NullPointerException - when the iterable is null

put

default <T> Iterable<T> put(Iterable<T> entities,
                            Duration ttl)

Saves the Iterable of entities with a defined time to live

Type Parameters:

T - the entity type

Parameters:

entities - entities to be insert

ttl - the time to entity expire

Returns:

the entities

Throws:

NullPointerException - when the iterable is null

UnsupportedOperationException - when expired time is not supported

get

<K,T> Optional<T> get(K key,
                      Class<T> entityClass)

Finds the Value from a key

Type Parameters:

K - the key type

T - the entity type

Parameters:

key - the key

entityClass - the entity class to convert the result

Returns:

the Optional when is not found will return a Optional.empty()

Throws:

NullPointerException - when the key is null

query

<T> Stream<T> query(String query,
                    Class<T> entityClass)

Executes query in the database

Type Parameters:

T - the entity type

Parameters:

query - the query

entityClass - the entity class

Returns:

the result list, if either put or remove it will return empty

Throws:

NullPointerException - when query is null, if the query is get the entity class is required

getSingleResult

<T> Optional<T> getSingleResult(String query,
                                Class<T> entityClass)

Executes query in the database then returns as single result

Type Parameters:

T - the entity type

Parameters:

query - the query

entityClass - the entity class

Returns:

the result Optional, if either put or remove it will return Optional.empty()

Throws:

NullPointerException - when query is null, if the query is get the entity class is required

query

void query(String query)

Executes query in the database and don't return result, e.g.: when the query is either remove or put

Parameters:

query - the query

Throws:

NullPointerException - when query is null

prepare

<T> PreparedStatement prepare(String query,
                              Class<T> entityClass)

Executes query with PreparedStatement

Type Parameters:

T - the entity type

Parameters:

query - the query

entityClass - the entity class

Returns:

a PreparedStatement instance

Throws:

NullPointerException - when query is null, if the query is get the entity class is required

get

<K,T> Iterable<T> get(Iterable<K> keys,
                      Class<T> entityClass)

Finds a list of values from keys

Type Parameters:

K - the key type

T - the entity type

Parameters:

entityClass - the entity class

keys - the keys to be used in this query

Returns:

the list of result

Throws:

NullPointerException - when either the keys or the entities values are null

delete

<K> void delete(K key)

Removes an entity from key

Type Parameters:

K - the key type

Parameters:

key - the key bo be used

Throws:

NullPointerException - when the key is null

delete

<K> void delete(Iterable<K> keys)

Removes entities from keys

Type Parameters:

K - the key type

Parameters:

keys - the keys to be used

Throws:

NullPointerException - when the key is null