cubicchunks.regionlib.api.region

Interface IRegionProvider<K extends IKey<K>>

Type Parameters:

K - The key type

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, java.io.Flushable

All Known Implementing Classes:

SharedCachedRegionProvider

public interface IRegionProvider<K extends IKey<K>>
extends java.io.Flushable, 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
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	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.

Methods inherited from interface java.io.Flushable

flush

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

allRegions

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

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.

Returns:

a Stream over the keys of all the existing regions

Throws:

java.io.IOException

allKeys

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

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.

Returns:

a Stream over all already saved keys

Throws:

java.io.IOException

allEntries

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

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.

Returns:

a Stream over all already saved entries

Throws:

java.io.IOException