net.morimekta.providence.storage

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

All Superinterfaces:

MessageListReadOnlyStore<K,M,F>

All Known Implementing Classes:

DirectoryMessageListStore, InMemoryMessageListStore

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

Interface for storing messages of a single type.

Method Summary

Modifier and Type	Method and Description
default List<M>	put(K key, List<M> list)
Map<K,List<M>>	putAll(Map<K,List<M>> values)
default <B extends PMessageBuilder<M,F>> Map<K,List<B>>	putAllBuilders(Map<K,List<B>> builders) Put messages into the map represented by their builders.
default <B extends PMessageBuilder<M,F>> List<B>	putBuilders(K key, List<B> builders) Put messages into the map represented by their builders.
default List<M>	remove(K key)
Map<K,List<M>>	removeAll(Collection<K> keys) Remove the values for the given keys;

Methods inherited from interface net.morimekta.providence.storage.MessageListReadOnlyStore

containsKey, get, getAll, getAllBuilders, getBuilders, keys

Method Detail

putAll

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

Parameters:

values - Put all key value pairs form this map into the storage. The list of messages should not contain null items.

Returns:

Immutable map of replaced values. Values not already present should not have an entry in the result map (no key -> null mapping).

removeAll

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

Remove the values for the given keys;

Parameters:

keys - Map of removed key value pairs.

Returns:

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

put

@Nullable
default List<M> put(@Nonnull
                              K key,
                              @Nonnull
                              List<M> list)

Parameters:

key - The key to put message at.

list - The list of message to put. The list should not contain null items.

Returns:

Replaced value if any.

remove

@Nullable
default List<M> remove(@Nonnull
                                 K key)

Parameters:

key - Entry key to remove from map.

Returns:

The list of messages removed or null if nothing was removed.

putBuilders

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

Put messages into the map represented by their builders. Further modifications to the builders will not be reflected onto the contents of the store.

Type Parameters:

B - The builder type.

Parameters:

key - The key to put builders to.

builders - The list of builders to put.

Returns:

The list of builders representing messages replaced, or null if new entry was created.

putAllBuilders

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

Put messages into the map represented by their builders. Further modifications to the builders will not be reflected onto the contents of the store.

Type Parameters:

B - The builder type.

Parameters:

builders - Map of key to list of builders.

Returns:

Map of builders that were replaced in the store. Will not contain (key -> null) mappings.