net.morimekta.providence.storage

Interface MessageStore<K,M extends PMessage<M,F>,F extends PField>

All Known Implementing Classes:

DirectoryMessageStore, InMemoryMessageStore

public interface MessageStore<K,M extends PMessage<M,F>,F extends PField>

Interface for storing messages of a single type.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(K key)
default M	get(K key) Get a single value from the storage.
Map<K,M>	getAll(Collection<K> keys) Look up a set of keys from the storage.
default <B extends PMessageBuilder<M,F>> Map<K,B>	getAllBuilders(Collection<K> keys)
default <B extends PMessageBuilder<M,F>> B	getBuilder(K key)
Collection<K>	keys() Get a collection of all the keys in the store.
default M	put(K key, M message)
Map<K,M>	putAll(Map<K,M> values)
default <B extends PMessageBuilder<M,F>> Map<K,B>	putAllBuilders(Map<K,B> builders)
default <B extends PMessageBuilder<M,F>> B	putBuilder(K key, B builder)
default M	remove(K key)
Map<K,M>	removeAll(Collection<K> keys) Remove the values for the given keys;

Method Detail

getAll

@Nonnull
Map<K,M> getAll(@Nonnull
                         Collection<K> keys)

Look up a set of keys from the storage.

Parameters:

keys - The keys to look up.

Returns:

The map of all the found key value pairs.

putAll

@Nonnull
Map<K,M> putAll(@Nonnull
                         Map<K,M> values)

Parameters:

values - Put all key value pairs form this map into the storage.

Returns:

Map of replaced values.

removeAll

@Nonnull
Map<K,M> removeAll(Collection<K> keys)

Remove the values for the given keys;

Parameters:

keys - Map of removed key value pairs.

Returns:

Map of removed key value pairs.

containsKey

boolean containsKey(@Nonnull
                    K key)

Parameters:

key - The key to look up.

Returns:

True if the key was contained in the map.

keys

@Nonnull
Collection<K> keys()

Get a collection of all the keys in the store.

Returns:

Key collection.

get

@Nullable
default M get(@Nonnull
                        K key)

Get a single value from the storage.

Parameters:

key - The key to look up.

Returns:

The value if present.

Throws:

IllegalStateException

put

@Nullable
default M put(@Nonnull
                        K key,
                        @Nonnull
                        M message)

Parameters:

key - The key to put message at.

message - The message to put.

remove

@Nullable
default M remove(@Nonnull
                           K key)

getBuilder

@Nullable
default <B extends PMessageBuilder<M,F>> B getBuilder(@Nonnull
                                                                K key)

getAllBuilders

@Nonnull
default <B extends PMessageBuilder<M,F>> Map<K,B> getAllBuilders(@Nonnull
                                                                          Collection<K> keys)

putBuilder

default <B extends PMessageBuilder<M,F>> B putBuilder(@Nonnull
                                                      K key,
                                                      @Nonnull
                                                      B builder)

putAllBuilders

default <B extends PMessageBuilder<M,F>> Map<K,B> putAllBuilders(@Nonnull
                                                                 Map<K,B> builders)