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.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(IRegionProvider<K> sourceProvider) Creates a RegionProvider using the given regionFactory and maxCacheSize

Method Summary

Modifier and Type	Method and Description
static void	clearRegions()
void	close()
void	forAllRegions(CheckedBiConsumer<RegionKey,? super IRegion<K>,java.io.IOException> consumer) Calls the given consumer for all existing region names.
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.
<R> java.util.Optional<R>	fromRegion(K location, CheckedFunction<? super IRegion<K>,R,java.io.IOException> func, boolean canCreate)
java.util.Optional<IRegion<K>>	getExistingRegion(K key) Gets an IRegion at a given region key, creates new one if it doesn't exist.
IRegion<K>	getRegion(K key) Gets an IRegion at a given region key, or create one if it does not exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedCachedRegionProvider

public SharedCachedRegionProvider(IRegionProvider<K> sourceProvider)

Creates a RegionProvider using the given regionFactory and maxCacheSize

Parameters:

sourceProvider - provider 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

getRegion

public IRegion<K> getRegion(K key)
                     throws java.io.IOException

Description copied from interface: IRegionProvider

Gets an IRegion at a given region key, or create one if it does not exist. The region will not be closed automatically. Region instance returned by this method won't be returned again, instead new one will be created (not cached).

Specified by:

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

Parameters:

key - The key for the IRegion

Returns:

The IRegion at regionKey

Throws:

java.io.IOException

getExistingRegion

public java.util.Optional<IRegion<K>> getExistingRegion(K key)
                                                 throws java.io.IOException

Description copied from interface: IRegionProvider

Gets an IRegion at a given region key, creates new one if it doesn't exist. The region will not be closed automatically. Region instance returned by this method won't be returned again, instead new one will be created (not cached).

Specified by:

getExistingRegion 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

forAllRegions

public void forAllRegions(CheckedBiConsumer<RegionKey,? super IRegion<K>,java.io.IOException> consumer)
                   throws java.io.IOException

Description copied from interface: IRegionProvider

Calls the given consumer for all existing region names.

Specified by:

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

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

fromRegion

public <R> java.util.Optional<R> fromRegion(K location,
                                            CheckedFunction<? super IRegion<K>,R,java.io.IOException> func,
                                            boolean canCreate)
                                     throws java.io.IOException

Throws:

java.io.IOException

clearRegions

public static void clearRegions()
                         throws java.io.IOException

Throws:

java.io.IOException