com.yahoo.bard.webservice.data.dimension

Interface KeyValueStore

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

MapStore, RedisStore

public interface KeyValueStore
extends Closeable

A simple key-value store.

Method Summary

Modifier and Type	Method and Description
void	close() Close the store.
String	get(String key) Get the value for a key from store.
default String	getOrDefault(String key, String defaultValue) Get the value for a key from store or provide a default.
boolean	isHealthy() Get the health status of the store.
boolean	isOpen() Get the open / closed status of the store.
void	open() Open the store.
String	put(String key, String value) Set a value for the key.
Map<String,String>	putAll(Map<String,String> entries) Set a multiple key/value pairs.
String	remove(String key) Remove a key from store.
default void	replaceStore(String newStorePath) Replaces key value store with a new key value store.

Method Detail

open

void open()

Open the store.

close

void close()

Close the store.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isOpen

boolean isOpen()

Get the open / closed status of the store.

Returns:

true if the store is open

remove

String remove(@NotNull
              String key)

Remove a key from store.

Parameters:

key - Key to remove

Returns:

The previous value for the key, or null if the key was not set

get

String get(@NotNull
           String key)

Get the value for a key from store.

Parameters:

key - Key to get the value for

Returns:

the value for corresponding key

getOrDefault

default String getOrDefault(@NotNull
                            String key,
                            String defaultValue)

Get the value for a key from store or provide a default.

Parameters:

key - Key to get the value for

defaultValue - A default value in case key is null

Returns:

the value for corresponding key

isHealthy

boolean isHealthy()

Get the health status of the store.

Returns:

true if store is healthy

put

String put(@NotNull
           String key,
           String value)

Set a value for the key.

Also removes the key if the value is null.

Parameters:

key - Key to set

value - Value to set for the given key

Returns:

The previous value for the key, or null if the key was not set

putAll

Map<String,String> putAll(@NotNull
                          Map<String,String> entries)

Set a multiple key/value pairs.

Removes any keys with a null value.

Parameters:

entries - Map of key/value pairs to put

Returns:

The previous values for the keys

replaceStore

default void replaceStore(String newStorePath)

Replaces key value store with a new key value store.

Parameters:

newStorePath - The location of the new store.