ome.smuggler.core.service.file

Interface KeyValueStore<K extends util.object.Identifiable,V>

All Known Implementing Classes:

KeyValueFileStore, MemoryKeyValueStore, TSafeKeyValueStore

public interface KeyValueStore<K extends util.object.Identifiable,V>

A persistent key-value store that associates a value V to an Identifiable key.

Method Summary

Modifier and Type	Method and Description
default V	get(K key) Gets the value associated to the specified key.
void	modify(K key, java.util.function.Function<V,V> operation) Updates the value associated to the specified key.
void	put(K key, V value) Maps a key to a value.
void	remove(K key) Deletes the mapping identified by the specified key.

Method Detail

put

void put(K key,
         V value)

Maps a key to a value. If the specified key is already associated to a value, the old value will be overwritten.

Parameters:

key - identifies the mapping.

value - the value to store.

Throws:

java.lang.NullPointerException - if any argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O occurs.

get

default V get(K key)

Gets the value associated to the specified key.

Parameters:

key - identifies the mapping.

Returns:

the value.

Throws:

java.lang.NullPointerException - if the argument is null.

java.lang.IllegalArgumentException - if no value is associated to the given key.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O occurs.

modify

void modify(K key,
            java.util.function.Function<V,V> operation)

Updates the value associated to the specified key.

Parameters:

key - identifies the mapping.

operation - is given the current value, does something with it and then returns the new value.

Throws:

java.lang.NullPointerException - if any argument is null.

java.lang.IllegalArgumentException - if no value is associated to the given key.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O occurs.

remove

void remove(K key)

Deletes the mapping identified by the specified key. Does nothing if no value is currently associated to the key.

Parameters:

key - identifies the mapping.

Throws:

java.lang.NullPointerException - if the argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O occurs.