jakarta.nosql.keyvalue

Interface KeyValueEntity

public interface KeyValueEntity

A bucket unit, it's a tuple that contains key its respective value.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	KeyValueEntity.KeyValueEntityProvider A provider of KeyValueEntity where it will return from two values where the first one is the key and the second one is the value of the entity.

Method Summary

Modifier and Type	Method and Description
Object	getKey() the key
<K> K	getKey(Class<K> clazz) Alias to Value.get(Class)
<K> K	getKey(TypeSupplier<K> typeSupplier) Alias to Value.get(TypeSupplier)
Object	getValue() The value
<V> V	getValue(Class<V> clazz) Alias to Value.get(Class)
<V> V	getValue(TypeSupplier<V> typeSupplier) Alias to Value.get(TypeSupplier)
static <K,V> KeyValueEntity	of(K key, V value) Creates a Key value instance

Method Detail

of

static <K,V> KeyValueEntity of(K key,
                               V value)

Creates a Key value instance

Type Parameters:

K - the key type

V - the value type

Parameters:

key - the key

value - the value

Returns:

a KeyValueEntity instance

Throws:

NullPointerException - when either key or value are null

getKey

Object getKey()

the key

Returns:

the value

getKey

<K> K getKey(Class<K> clazz)

Alias to Value.get(Class)

Type Parameters:

K - Value.get(Class)

Parameters:

clazz - Value.get(Class)

Returns:

Value.get(Class)

Throws:

NullPointerException - see Value.get(Class)

UnsupportedOperationException - see Value.get(Class)

getKey

<K> K getKey(TypeSupplier<K> typeSupplier)

Alias to Value.get(TypeSupplier)

Type Parameters:

K - Value.get(TypeSupplier)

Parameters:

typeSupplier - Value.get(TypeSupplier)

Returns:

Value.get(TypeSupplier)

Throws:

NullPointerException - see Value.get(TypeSupplier)

UnsupportedOperationException - see Value.get(TypeSupplier)

getValue

Object getValue()

The value

Returns:

the value

See Also:

Value

getValue

<V> V getValue(Class<V> clazz)

Alias to Value.get(Class)

Type Parameters:

V - Value.get(Class)

Parameters:

clazz - Value.get(Class)

Returns:

Value.get(Class)

Throws:

NullPointerException - see Value.get(Class)

UnsupportedOperationException - see Value.get(Class)

getValue

<V> V getValue(TypeSupplier<V> typeSupplier)

Alias to Value.get(TypeSupplier)

Type Parameters:

V - Value.get(TypeSupplier)

Parameters:

typeSupplier - Value.get(TypeSupplier)

Returns:

Value.get(TypeSupplier)

Throws:

NullPointerException - see Value.get(TypeSupplier)

UnsupportedOperationException - see Value.get(TypeSupplier)