cubicchunks.regionlib.lib.factory

Class SimpleRegionFactory<K extends IKey<K>>

java.lang.Object

cubicchunks.regionlib.lib.factory.SimpleRegionFactory<K>

Type Parameters:

K - The key type

All Implemented Interfaces:

IRegionFactory<K>

public class SimpleRegionFactory<K extends IKey<K>>
extends java.lang.Object
implements IRegionFactory<K>

A simple implementation of IRegionFactory.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

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.
static <K extends IKey<K>> SimpleRegionFactory<K>	createDefault(IKeyProvider<K> keyProvider, java.nio.file.Path directory, int sectorSize)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleRegionFactory

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

Method Detail

createDefault

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

getKeyProvider

public IKeyProvider<K> getKeyProvider()

Specified by:

getKeyProvider in interface IRegionFactory<K extends IKey<K>>

Returns:

the IKeyProvider used by this factory

getRegion

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

Description copied from interface: IRegionFactory

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

Specified by:

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

Parameters:

key - the key for the IRegion

Returns:

the IRegion at the given key

Throws:

java.io.IOException

getExistingRegion

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

Description copied from interface: IRegionFactory

Opens an existing IRegion at a given region key.

Specified by:

getExistingRegion in interface IRegionFactory<K extends IKey<K>>

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

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

Description copied from interface: IRegionFactory

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.

Specified by:

allRegions in interface IRegionFactory<K extends IKey<K>>

Returns:

a Stream over the keys of all the existing regions

Throws:

java.io.IOException