software.chronicle.datagrid.internal.map

Class FilePerKeyValueStore

java.lang.Object

net.openhft.chronicle.core.io.SimpleCloseable

software.chronicle.datagrid.internal.map.FilePerKeyValueStore

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, AuthenticatedKeyValueStore<String,net.openhft.chronicle.bytes.BytesStore>, KeyValueStore<String,net.openhft.chronicle.bytes.BytesStore>, StringBytesStoreKeyValueStore, SubscriptionKeyValueStore<String,net.openhft.chronicle.bytes.BytesStore>, Assetted<KeyValueStore<String,net.openhft.chronicle.bytes.BytesStore>>, KeyedView

public final class FilePerKeyValueStore
extends net.openhft.chronicle.core.io.SimpleCloseable
implements StringBytesStoreKeyValueStore

A Map implementation that stores each entry as a file in a directory. The key is the file fullName 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 software.chronicle.datagrid.map.KeyValueStore

KeyValueStore.Entry<K,V>

Field Summary

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT

Constructor Summary

Constructors

Constructor and Description
FilePerKeyValueStore(@NotNull RequestContext context, @NotNull Asset asset)

Method Summary

Modifier and Type	Method and Description
@NotNull Asset	asset()
void	clear()
boolean	containsValue(net.openhft.chronicle.bytes.BytesStore value)
void	entriesFor(int segment, @NotNull SubscriptionConsumer<MapEvent<String,net.openhft.chronicle.bytes.BytesStore>> kvConsumer)
Iterator<Map.Entry<String,net.openhft.chronicle.bytes.BytesStore>>	entrySetIterator()
@Nullable net.openhft.chronicle.bytes.BytesStore	getAndPut(String key, @NotNull net.openhft.chronicle.bytes.BytesStore value)
@Nullable net.openhft.chronicle.bytes.BytesStore	getAndRemove(String key)
@Nullable net.openhft.chronicle.bytes.BytesStore	getUsing(String key, Object value)
Iterator<String>	keySetIterator()
void	keysFor(int segment, @NotNull SubscriptionConsumer<String> stringConsumer)
long	longSize()
protected void	performClose()
boolean	put(String key, @NotNull net.openhft.chronicle.bytes.BytesStore value) put an entry
boolean	remove(String key) remove a key
@NotNull RawKVSSubscription<String,net.openhft.chronicle.bytes.BytesStore>	subscription(boolean createIfAbsent)
@Nullable KeyValueStore<String,net.openhft.chronicle.bytes.BytesStore>	underlying()

Methods inherited from class net.openhft.chronicle.core.io.SimpleCloseable

close, isClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.chronicle.datagrid.map.KeyValueStore

containsKey, get, isKeyType, isReadOnly, putIfAbsent, removeIfEqual, replace, replaceIfEqual, segmentFor, segments, valuesIterator

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

close, closeQuietly, closeQuietly, notifyClosing, warnAndCloseIfNotClosed

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosed, isClosing, throwExceptionIfClosed

Methods inherited from interface software.chronicle.datagrid.tree.KeyedView

keyedView

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceId, referenceName, temporary

Methods inherited from interface net.openhft.chronicle.core.io.ManagedCloseable

createdHere, throwExceptionIfClosed, warnAndCloseIfNotClosed

Constructor Detail

FilePerKeyValueStore

public FilePerKeyValueStore(@NotNull
                            @NotNull RequestContext context,
                            @NotNull
                            @NotNull Asset asset)

Method Detail

subscription

@NotNull
public @NotNull RawKVSSubscription<String,net.openhft.chronicle.bytes.BytesStore> subscription(boolean createIfAbsent)

Specified by:

subscription in interface SubscriptionKeyValueStore<String,net.openhft.chronicle.bytes.BytesStore>

longSize

public long longSize()

Specified by:

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

getUsing

@Nullable
public @Nullable net.openhft.chronicle.bytes.BytesStore getUsing(String key,
                                                                           Object value)

Specified by:

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

keysFor

public void keysFor(int segment,
                    @NotNull
                    @NotNull SubscriptionConsumer<String> stringConsumer)

Specified by:

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

entriesFor

public void entriesFor(int segment,
                       @NotNull
                       @NotNull SubscriptionConsumer<MapEvent<String,net.openhft.chronicle.bytes.BytesStore>> kvConsumer)
                throws InvalidSubscriberException

Specified by:

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

Throws:

InvalidSubscriberException

keySetIterator

public Iterator<String> keySetIterator()

Specified by:

keySetIterator in interface KeyValueStore<String,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.BytesStore>

put

public boolean put(String key,
                   @NotNull
                   @NotNull net.openhft.chronicle.bytes.BytesStore value)

Description copied from interface: KeyValueStore

put an entry

Specified by:

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

Parameters:

key - to set

value - to set

Returns:

true if it was replaced or the value is identical, false if it was added.

getAndPut

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

Specified by:

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

getAndRemove

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

Specified by:

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

remove

public boolean remove(String key)

Description copied from interface: KeyValueStore

remove a key

Specified by:

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

Parameters:

key - to remove

Returns:

true if it was removed, false if not.

clear

public void clear()

Specified by:

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

containsValue

public boolean containsValue(net.openhft.chronicle.bytes.BytesStore value)

Specified by:

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

performClose

protected void performClose()

Overrides:

performClose in class net.openhft.chronicle.core.io.SimpleCloseable

asset

@NotNull
public @NotNull Asset asset()

Specified by:

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

Returns:

The Asset this resource is associated with.

underlying

@Nullable
public @Nullable KeyValueStore<String,net.openhft.chronicle.bytes.BytesStore> underlying()

Specified by:

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

Returns:

The Underlying view this view is built on.