net.morimekta.providence.storage

Class DirectoryMessageStore<K,M extends net.morimekta.providence.PMessage<M>>

java.lang.Object

net.morimekta.providence.storage.DirectoryMessageStore<K,M>

Type Parameters:

K - The key type.

M - The stored message type.

All Implemented Interfaces:

Closeable, AutoCloseable, MessageReadOnlyStore<K,M>, MessageStore<K,M>, ReadOnlyStore<K,M>, ReadWriteStore<K,M>

public class DirectoryMessageStore<K,M extends net.morimekta.providence.PMessage<M>>
extends Object
implements MessageStore<K,M>, Closeable

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

Note that the directory store is not 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 DirectoryMessageStore instance active at a time.

Constructor Summary

Constructors

Constructor and Description
DirectoryMessageStore(FileManager<K> manager, net.morimekta.providence.descriptor.PMessageDescriptor<M> descriptor, net.morimekta.providence.serializer.Serializer serializer)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	containsKey(K key)
Map<K,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.
void	putAll(Map<K,M> values)
void	removeAll(Collection<K> keys) Remove the values for the given keys.
int	size()

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

putAllBuilders, putBuilder

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

getAllBuilders, getBuilder

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

put, remove

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

get

Constructor Detail

DirectoryMessageStore

public DirectoryMessageStore(@Nonnull
                             FileManager<K> manager,
                             @Nonnull
                             net.morimekta.providence.descriptor.PMessageDescriptor<M> descriptor,
                             @Nonnull
                             net.morimekta.providence.serializer.Serializer serializer)

Method Detail

containsKey

public boolean containsKey(@Nonnull
                           K key)

Specified by:

containsKey in interface ReadOnlyStore<K,M extends net.morimekta.providence.PMessage<M>>

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: ReadOnlyStore

Get a collection of all the keys in the store.

Specified by:

keys in interface ReadOnlyStore<K,M extends net.morimekta.providence.PMessage<M>>

Returns:

Key collection.

size

public int size()

Specified by:

size in interface ReadOnlyStore<K,M extends net.morimekta.providence.PMessage<M>>

Returns:

Get the total number of entries in the store, same as the number of unique keys.

getAll

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

Description copied from interface: ReadOnlyStore

Look up a set of keys from the storage.

Specified by:

getAll in interface ReadOnlyStore<K,M extends net.morimekta.providence.PMessage<M>>

Parameters:

keys - The keys to look up.

Returns:

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

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

Specified by:

putAll in interface ReadWriteStore<K,M extends net.morimekta.providence.PMessage<M>>

Parameters:

values - Put all key value pairs form this map into the storage.

removeAll

public void removeAll(Collection<K> keys)

Description copied from interface: ReadWriteStore

Remove the values for the given keys.

Specified by:

removeAll in interface ReadWriteStore<K,M extends net.morimekta.providence.PMessage<M>>

Parameters:

keys - Map of removed key value pairs.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable