net.morimekta.providence.storage

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

All Known Subinterfaces:

MessageListStore<K,M,F>

All Known Implementing Classes:

DirectoryMessageListStore, InMemoryMessageListStore

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

Interface for storing messages of a single type. This is a read-only part of the store.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(K key)
default List<M>	get(K key) Get a single value from the storage.
Map<K,List<M>>	getAll(Collection<K> keys) Look up a set of keys from the storage.
default <B extends PMessageBuilder<M,F>> Map<K,List<B>>	getAllBuilders(Collection<K> keys) Get map of lists of builders for all the messages for the requested keys.
default <B extends PMessageBuilder<M,F>> List<B>	getBuilders(K key) Get a list of builders for the entry stored.
Collection<K>	keys() Get a collection of all the keys in the store.

Method Detail

getAll

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

Look up a set of keys from the storage.

Parameters:

keys - The keys to look up.

Returns:

Immutable map of all the found key value pairs. Values not found should not have an entry in the result map (no key -> null mapping).

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 List<M> get(@Nonnull
                              K key)

Get a single value from the storage.

Parameters:

key - The key to look up.

Returns:

The value if present.

getBuilders

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

Get a list of builders for the entry stored. Any modifications to the returned builders will not be reflected onto the store.

Type Parameters:

B - The builder type.

Parameters:

key - The key to look up.

Returns:

List of builders for stored on the key or null if not found.

getAllBuilders

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

Get map of lists of builders for all the messages for the requested keys. The resulting map will not contain key -> null mappings. Any modifications to the returned builders will not be reflected onto the store.

Type Parameters:

B - The builder type.

Parameters:

keys - Collection of keys to request.

Returns:

Map of entries found.