net.morimekta.providence.storage

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

All Known Subinterfaces:

MessageStore<K,M,F>

All Known Implementing Classes:

DirectoryMessageStore, InMemoryMessageStore

public interface MessageReadOnlyStore<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 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) Get builders for all keys requested.
default <B extends PMessageBuilder<M,F>> B	getBuilder(K key) Get the builder representing the message on the given key.
Collection<K>	keys() Get a collection of all the keys in the store.

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:

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

Get a single value from the storage.

Parameters:

key - The key to look up.

Returns:

The value if present.

getBuilder

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

Get the builder representing the message on the given key. Any modifications to the returned builder will not be reflected onto the store.

Type Parameters:

B - The builder type.

Parameters:

key - The key to find builder for.

Returns:

The builder if message was found or null if not.

getAllBuilders

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

Get builders for all keys requested. Any modifications to the returned builders will not be reflected onto the store. The result map fill not contain any (key -> null) entries.

Type Parameters:

B - The builder type.

Parameters:

keys - Keys to look up.

Returns:

The map of found entries.