net.openhft.chronicle.engine2.map

Class FilePerKeyValueStore

java.lang.Object

net.openhft.chronicle.engine2.map.FilePerKeyValueStore

All Implemented Interfaces:

Closeable, AutoCloseable, Assetted<KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>>, KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>, StringBytesStoreKeyValueStore, SubscriptionKeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>, Subscription, View

public class FilePerKeyValueStore
extends Object
implements StringBytesStoreKeyValueStore, Closeable

A Map implementation that stores each entry as a file in a directory. The key is the file name and the value is the contents of the file.

The class is effectively an abstraction over a directory in the file system. Therefore when the underlying files are changed an event will be fired to those registered for notifications.

Updates will be fired every time the file is saved but will be suppressed if the value has not changed. To avoid temporary files (e.g. if edited in vi) being included in the map, any file starting with a '.' will be ignored.

Note the WatchService is extremely OS dependant. Mas OSX registers very few events if they are done quickly and there is a significant delay between the event and the event being triggered.

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.engine2.api.map.KeyValueStore

KeyValueStore.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
FilePerKeyValueStore(FactoryContext context)

Method Summary

Modifier and Type	Method and Description
Asset	asset()
void	asset(Asset asset)
void	clear()
void	close()
void	entriesFor(int segment, java.util.function.Consumer<KeyValueStore.Entry<String,net.openhft.chronicle.bytes.BytesStore>> kvConsumer)
Iterator<Map.Entry<String,net.openhft.chronicle.bytes.BytesStore>>	entrySetIterator()
View	forSession(LocalSession session, Asset asset)
net.openhft.chronicle.bytes.BytesStore	getAndPut(String key, net.openhft.chronicle.bytes.BytesStore value)
net.openhft.chronicle.bytes.BytesStore	getAndRemove(String key)
net.openhft.chronicle.bytes.BytesStore	getUsing(String key, net.openhft.chronicle.bytes.Bytes value)
void	keysFor(int segment, java.util.function.Consumer<String> stringConsumer)
void	put(String key, net.openhft.chronicle.bytes.BytesStore value)
<E> void	registerSubscriber(Class<E> eClass, Subscriber<E> subscriber, String query)
<T,E> void	registerTopicSubscriber(Class<T> tClass, Class<E> eClass, TopicSubscriber<T,E> subscriber, String query)
void	remove(String key)
long	size()
KeyValueStore	underlying()
void	underlying(KeyValueStore underlying)
<E> void	unregisterSubscriber(Class<E> eClass, Subscriber<E> subscriber, String query)
<T,E> void	unregisterTopicSubscriber(Class<T> tClass, Class<E> eClass, TopicSubscriber<T,E> subscriber, String query)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.engine2.api.map.KeyValueStore

containsKey, get, isReadOnly, replace, segmentFor, segments

Methods inherited from interface net.openhft.chronicle.engine2.api.Assetted

isUnderlying

Methods inherited from interface net.openhft.chronicle.engine2.api.View

forSession

Constructor Detail

FilePerKeyValueStore

public FilePerKeyValueStore(FactoryContext context)
                     throws net.openhft.chronicle.bytes.IORuntimeException

Throws:

net.openhft.chronicle.bytes.IORuntimeException

Method Detail

forSession

public View forSession(LocalSession session,
                       Asset asset)

Specified by:

forSession in interface View

size

public long size()

Specified by:

size in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

getUsing

public net.openhft.chronicle.bytes.BytesStore getUsing(String key,
                                                       net.openhft.chronicle.bytes.Bytes value)

Specified by:

getUsing in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

keysFor

public void keysFor(int segment,
                    java.util.function.Consumer<String> stringConsumer)

Specified by:

keysFor in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

entriesFor

public void entriesFor(int segment,
                       java.util.function.Consumer<KeyValueStore.Entry<String,net.openhft.chronicle.bytes.BytesStore>> kvConsumer)

Specified by:

entriesFor in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

entrySetIterator

public Iterator<Map.Entry<String,net.openhft.chronicle.bytes.BytesStore>> entrySetIterator()

Specified by:

entrySetIterator in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

put

public void put(String key,
                net.openhft.chronicle.bytes.BytesStore value)

Specified by:

put in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

getAndPut

public net.openhft.chronicle.bytes.BytesStore getAndPut(String key,
                                                        net.openhft.chronicle.bytes.BytesStore value)

Specified by:

getAndPut in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

getAndRemove

public net.openhft.chronicle.bytes.BytesStore getAndRemove(String key)

Specified by:

getAndRemove in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

remove

public void remove(String key)

Specified by:

remove in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

clear

public void clear()

Specified by:

clear in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

registerSubscriber

public <E> void registerSubscriber(Class<E> eClass,
                                   Subscriber<E> subscriber,
                                   String query)

Specified by:

registerSubscriber in interface Subscription

registerTopicSubscriber

public <T,E> void registerTopicSubscriber(Class<T> tClass,
                                          Class<E> eClass,
                                          TopicSubscriber<T,E> subscriber,
                                          String query)

Specified by:

registerTopicSubscriber in interface Subscription

unregisterSubscriber

public <E> void unregisterSubscriber(Class<E> eClass,
                                     Subscriber<E> subscriber,
                                     String query)

Specified by:

unregisterSubscriber in interface Subscription

unregisterTopicSubscriber

public <T,E> void unregisterTopicSubscriber(Class<T> tClass,
                                            Class<E> eClass,
                                            TopicSubscriber<T,E> subscriber,
                                            String query)

Specified by:

unregisterTopicSubscriber in interface Subscription

asset

public void asset(Asset asset)

Specified by:

asset in interface Assetted<KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>>

asset

public Asset asset()

Specified by:

asset in interface Assetted<KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>>

underlying

public void underlying(KeyValueStore underlying)

Specified by:

underlying in interface Assetted<KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>>

underlying

public KeyValueStore underlying()

Specified by:

underlying in interface Assetted<KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>>