net.morimekta.providence.storage

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

All Superinterfaces:

MessageReadOnlyStore<K,M,F>

All Known Implementing Classes:

DirectoryMessageStore, InMemoryMessageStore

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

Interface for storing messages of a single type.

Method Summary

Modifier and Type	Method and Description
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) Put a collection of key and builder pairs onto the store.
default <B extends PMessageBuilder<M,F>> B	putBuilder(K key, B builder) Put the message represented by the builder into the store on the given key.
default M	remove(K key) Remove the key value pair from the store.
Map<K,M>	removeAll(Collection<K> keys) Remove the values for the given keys.

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

containsKey, get, getAll, getAllBuilders, getBuilder, keys

Method Detail

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:

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,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 M put(@Nonnull
                        K key,
                        @Nonnull
                        M message)

Parameters:

key - The key to put message at.

message - The message to put.

Returns:

Replaced value if any.

remove

@Nullable
default M remove(@Nonnull
                           K key)

Remove the key value pair from the store.

Parameters:

key - The key to remove.

Returns:

The message removed if any, otherwise null.

putBuilder

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

Put the message represented by the builder into the store on the given key. Any further modifications to the builder will not be reflected on the store.

Type Parameters:

B - The builder type.

Parameters:

key - The key to store the builder on.

builder - The builder to store.

Returns:

The replaced builder if one was replaced. Null if theentry was created. Any modifications to the returned builder will not be reflected onto the store.

putAllBuilders

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

Put a collection of key and builder pairs onto the store. Any further modifications to the builders will not be reflected onto the store.

Type Parameters:

B - The builder type.

Parameters:

builders - Map of builders to put into the store.

Returns:

Map of replaced entries. Any modifications to the returned builders will not be reflected onto the store.