cubicchunks.regionlib.api.region

Interface IRegionProvider<K extends IKey<K>>

Type Parameters:

K - The key type

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

CachedRegionProvider, SharedCachedRegionProvider, SimpleRegionProvider

public interface IRegionProvider<K extends IKey<K>>
extends java.io.Closeable

Provides a by-key access to Regions, also allows to get access to all existing regions. Can be used as a source of regions (creation/loading/caching).

Method Summary

Modifier and Type	Method and Description
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 interface java.io.Closeable

close

Method Detail

forRegion

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

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.

Parameters:

key - The key for the IRegion

consumer - Consumer that accepts the IRegion

Throws:

java.io.IOException

fromExistingRegion

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

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.

Parameters:

key - The key for the IRegion

Returns:

An Optional containing the IRegion at regionKey if it exists

Throws:

java.io.IOException

fromRegion

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

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.

Parameters:

key - The key for the IRegion

Throws:

java.io.IOException

forExistingRegion

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

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.

Parameters:

key - The key for the IRegion

consumer - Accepts the given region, if it already exists

Throws:

java.io.IOException

getRegion

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

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

Parameters:

key - The key for the IRegion

Returns:

The IRegion at regionKey

Throws:

java.io.IOException

getExistingRegion

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

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

Parameters:

key - The key for the IRegion

Returns:

An Optional containing the IRegion at regionKey if it exists

Throws:

java.io.IOException

forAllRegions

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

Calls the given consumer for all existing region names.

Throws:

java.io.IOException