cubicchunks.regionlib.lib.provider

Class SimpleRegionProvider<K extends IKey<K>>

java.lang.Object

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

Type Parameters:

K - The key type

All Implemented Interfaces:

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

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

A simple implementation of IRegionProvider, this is intended to be used together with CachedRegionProvider or other caching implementation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SimpleRegionProvider.RegionExistsPredicate<K extends IKey<K>>
static interface	SimpleRegionProvider.RegionFactory<K extends IKey<K>>

Constructor Summary

Constructors

Constructor and Description
SimpleRegionProvider(IKeyProvider<K> keyProvider, java.nio.file.Path directory, SimpleRegionProvider.RegionFactory<K> regionBuilder, SimpleRegionProvider.RegionExistsPredicate<K> regionExists)

Method Summary

Modifier and Type	Method and Description
void	close()
static <K extends IKey<K>> SimpleRegionProvider<K>	createDefault(IKeyProvider<K> keyProvider, java.nio.file.Path directory, int sectorSize)
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> consumer) 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> consumer) 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.
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

SimpleRegionProvider

public SimpleRegionProvider(IKeyProvider<K> keyProvider,
                            java.nio.file.Path directory,
                            SimpleRegionProvider.RegionFactory<K> regionBuilder,
                            SimpleRegionProvider.RegionExistsPredicate<K> regionExists)

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> consumer)
               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

consumer - Consumer that accepts the IRegion

Throws:

java.io.IOException

forExistingRegion

public void forExistingRegion(K key,
                              CheckedConsumer<? super IRegion<K>,java.io.IOException> consumer)
                       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

consumer - 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()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

createDefault

public static <K extends IKey<K>> SimpleRegionProvider<K> createDefault(IKeyProvider<K> keyProvider,
                                                                        java.nio.file.Path directory,
                                                                        int sectorSize)