cubicchunks.regionlib.api.region

Interface IRegionFactory<K extends IKey<K>>

Type Parameters:

K - The key type

All Known Implementing Classes:

SimpleRegionFactory

public interface IRegionFactory<K extends IKey<K>>

Provides access to regions in a directory.

Note that all IRegion instances returned will be newly created. Users are responsible for ensuring that multiple regions corresponding to the same key are not open at once. Therefore, this should be used with some caching implementation of IRegionProvider (such as SharedCachedRegionProvider).

Method Summary

Modifier and Type	Method and Description
java.util.stream.Stream<RegionKey>	allRegions() Gets a Stream over the keys of all the existing regions.
java.util.Optional<IRegion<K>>	getExistingRegion(RegionKey key) Opens an existing IRegion at a given region key.
IKeyProvider<K>	getKeyProvider()
IRegion<K>	getRegion(RegionKey key) Opens an IRegion at a given region key, creating a new one if none exists.

Method Detail

getKeyProvider

IKeyProvider<K> getKeyProvider()

Returns:

the IKeyProvider used by this factory

getRegion

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

Opens an IRegion at a given region key, creating a new one if none exists.

Parameters:

key - the key for the IRegion

Returns:

the IRegion at the given key

Throws:

java.io.IOException

getExistingRegion

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

Opens an existing IRegion at a given region key.

Parameters:

key - the key for the IRegion

Returns:

the IRegion at the given key, or an empty Optional if none 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.

Note that the returned Stream must be closed (using BaseStream.close()) once no longer needed.

Returns:

a Stream over the keys of all the existing regions

Throws:

java.io.IOException