net.morimekta.providence.storage

Class DirectoryMessageListStore<K,M extends PMessage<M,F>,F extends PField>

java.lang.Object

net.morimekta.providence.storage.DirectoryMessageListStore<K,M,F>

All Implemented Interfaces:

Closeable, AutoCloseable, MessageListReadOnlyStore<K,M,F>, MessageListStore<K,M,F>

public class DirectoryMessageListStore<K,M extends PMessage<M,F>,F extends PField>
extends Object
implements MessageListStore<K,M,F>, Closeable

Simple file-based storage of lists of providence messages that keeps an in-memory key index, a message cache, and stores message lists to individual files in a single directly.

Note that the directory store is parallel compatible between instances, as all of them would be able to read, write etc all the files all the time.

TL;DR Each directory can only have one DirectoryMessageListStore instance active at a time.

Constructor Summary

Constructors

Constructor and Description
DirectoryMessageListStore(File directory, Function<K,String> keyBuilder, Function<String,K> keyParser, PMessageDescriptor<M,F> descriptor, Serializer serializer)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	containsKey(K key)
Map<K,List<M>>	getAll(Collection<K> keys) Look up a set of keys from the storage.
Collection<K>	keys() Get a collection of all the keys in the store.
Map<K,List<M>>	putAll(Map<K,List<M>> values)
Map<K,List<M>>	removeAll(Collection<K> keys) Remove the values for the given keys;

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

put, putAllBuilders, putBuilders, remove

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

get, getAllBuilders, getBuilders

Constructor Detail

DirectoryMessageListStore

public DirectoryMessageListStore(@Nonnull
                                 File directory,
                                 @Nonnull
                                 Function<K,String> keyBuilder,
                                 @Nonnull
                                 Function<String,K> keyParser,
                                 @Nonnull
                                 PMessageDescriptor<M,F> descriptor,
                                 @Nonnull
                                 Serializer serializer)

Method Detail

containsKey

public boolean containsKey(@Nonnull
                           K key)

Specified by:

containsKey in interface MessageListReadOnlyStore<K,M extends PMessage<M,F>,F extends PField>

Parameters:

key - The key to look up.

Returns:

True if the key was contained in the map.

keys

@Nonnull
public Collection<K> keys()

Description copied from interface: MessageListReadOnlyStore

Get a collection of all the keys in the store.

Specified by:

keys in interface MessageListReadOnlyStore<K,M extends PMessage<M,F>,F extends PField>

Returns:

Key collection.

getAll

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

Description copied from interface: MessageListReadOnlyStore

Look up a set of keys from the storage.

Specified by:

getAll in interface MessageListReadOnlyStore<K,M extends PMessage<M,F>,F extends PField>

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).

putAll

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

Specified by:

putAll in interface MessageListStore<K,M extends PMessage<M,F>,F extends PField>

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
public Map<K,List<M>> removeAll(Collection<K> keys)

Description copied from interface: MessageListStore

Remove the values for the given keys;

Specified by:

removeAll in interface MessageListStore<K,M extends PMessage<M,F>,F extends PField>

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).

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException