cubicchunks.regionlib.lib.provider

Class SharedCachedRegionProvider<K extends IKey<K>>

java.lang.Object

cubicchunks.regionlib.lib.provider.SharedCachedRegionProvider<K>

All Implemented Interfaces:

IRegionProvider<K>, java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class SharedCachedRegionProvider<K extends IKey<K>>
extends java.lang.Object
implements IRegionProvider<K>

A region caching provider that uses a shared underlying cache for all instances

Constructor Summary

Constructors

Constructor and Description
SharedCachedRegionProvider(IRegionFactory<K> regionFactory) Creates a RegionProvider using the given regionFactory
SharedCachedRegionProvider(IRegionFactory<K> regionFactory, SharedCache cache) Creates a RegionProvider using the given regionFactory and cache

Method Summary

Modifier and Type	Method and Description
java.util.stream.Stream<java.util.Map.Entry<K,java.nio.ByteBuffer>>	allEntries() Gets a Stream over all already saved entries.
java.util.stream.Stream<K>	allKeys() Gets a Stream over all already saved keys.
java.util.stream.Stream<RegionKey>	allRegions() Gets a Stream over the keys of all the existing regions.
void	close()
void	flush()
void	forExistingRegion(K key, CheckedConsumer<? super IRegion<K>,java.io.IOException> cons) Calls the given function with region at that location and returns value from that function..
void	forRegion(K key, CheckedConsumer<? super IRegion<K>,java.io.IOException> cons) Calls the given consumer with region at that location.
<R> java.util.Optional<R>	fromExistingRegion(K key, CheckedFunction<? super IRegion<K>,R,java.io.IOException> func) Calls the given consumer with region at that location.
<R> R	fromRegion(K key, CheckedFunction<? super IRegion<K>,R,java.io.IOException> func) Calls the given function with region at that location and returns value from that function.

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedCachedRegionProvider

public SharedCachedRegionProvider(IRegionFactory<K> regionFactory)

Creates a RegionProvider using the given regionFactory

Parameters:

regionFactory - IRegionFactory used as source of regions

SharedCachedRegionProvider

public SharedCachedRegionProvider(IRegionFactory<K> regionFactory,
                                  SharedCache cache)

Creates a RegionProvider using the given regionFactory and cache

Parameters:

regionFactory - IRegionFactory used as source of regions

Method Detail

fromExistingRegion

public <R> java.util.Optional<R> fromExistingRegion(K key,
                                                    CheckedFunction<? super IRegion<K>,R,java.io.IOException> func)
                                             throws java.io.IOException

Description copied from interface: IRegionProvider

Calls the given consumer with region at that location. Doesn't create new region if one doesn't exist yet. The region will be closed automatically as needed.

Specified by:

fromExistingRegion in interface IRegionProvider<K extends IKey<K>>

Parameters:

key - The key for the IRegion

Returns:

An Optional containing the IRegion at regionKey if it exists

Throws:

java.io.IOException

fromRegion

public <R> R fromRegion(K key,
                        CheckedFunction<? super IRegion<K>,R,java.io.IOException> func)
                 throws java.io.IOException

Description copied from interface: IRegionProvider

Calls the given function with region at that location and returns value from that function. Creates new region if one doesn't exist yet. The region will be closed automatically as needed.

Specified by:

fromRegion in interface IRegionProvider<K extends IKey<K>>

Parameters:

key - The key for the IRegion

Throws:

java.io.IOException

forRegion

public void forRegion(K key,
                      CheckedConsumer<? super IRegion<K>,java.io.IOException> cons)
               throws java.io.IOException

Description copied from interface: IRegionProvider

Calls the given consumer with region at that location. Creates new region if one doesn't exist yet. The region will be closed automatically as needed.

Specified by:

forRegion in interface IRegionProvider<K extends IKey<K>>

Parameters:

key - The key for the IRegion

cons - Consumer that accepts the IRegion

Throws:

java.io.IOException

forExistingRegion

public void forExistingRegion(K key,
                              CheckedConsumer<? super IRegion<K>,java.io.IOException> cons)
                       throws java.io.IOException

Description copied from interface: IRegionProvider

Calls the given function with region at that location and returns value from that function.. Doesn't create new region if one doesn't exist yet. The region will be closed automatically as needed.

Specified by:

forExistingRegion in interface IRegionProvider<K extends IKey<K>>

Parameters:

key - The key for the IRegion

cons - Accepts the given region, if it already exists

Throws:

java.io.IOException

allRegions

public java.util.stream.Stream<RegionKey> allRegions()
                                              throws java.io.IOException

Description copied from interface: IRegionProvider

Gets a Stream over the keys of all the existing regions.

All regions that had been created at the time of this method invocation are guaranteed to be present in the returned Stream, no guarantees are made for regions created during iteration.

The returned Stream should be closed (using BaseStream.close()) once no longer needed to avoid potential resource leaks. If not closed, any resources allocated by the Stream may not be freed until the Stream instance is garbage-collected.

Specified by:

allRegions in interface IRegionProvider<K extends IKey<K>>

Returns:

a Stream over the keys of all the existing regions

Throws:

java.io.IOException

allKeys

public java.util.stream.Stream<K> allKeys()
                                   throws java.io.IOException

Description copied from interface: IRegionProvider

Gets a Stream over all already saved keys.

Keys saved while the Stream is being evaluated are not guaranteed to be listed.

The returned Stream should be closed (using BaseStream.close()) once no longer needed to avoid potential resource leaks. If not closed, any resources allocated by the Stream may not be freed until the Stream instance is garbage-collected.

Specified by:

allKeys in interface IRegionProvider<K extends IKey<K>>

Returns:

a Stream over all already saved keys

Throws:

java.io.IOException

allEntries

public java.util.stream.Stream<java.util.Map.Entry<K,java.nio.ByteBuffer>> allEntries()
                                                                               throws java.io.IOException

Description copied from interface: IRegionProvider

Gets a Stream over all already saved entries.

Entries saved while the Stream is being evaluated are not guaranteed to be listed.

The returned Stream should be closed (using BaseStream.close()) once no longer needed to avoid potential resource leaks. If not closed, any resources allocated by the Stream may not be freed until the Stream instance is garbage-collected.

Specified by:

allEntries in interface IRegionProvider<K extends IKey<K>>

Returns:

a Stream over all already saved entries

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException