cubicchunks.regionlib.api.storage

Class SaveSection<S extends SaveSection<S,K>,K extends IKey<K>>

java.lang.Object

cubicchunks.regionlib.api.storage.SaveSection<S,K>

Type Parameters:

S - This type

K - The location key type

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

MinecraftSaveSection, SaveSection2D, SaveSection3D

public abstract class SaveSection<S extends SaveSection<S,K>,K extends IKey<K>>
extends java.lang.Object
implements java.io.Closeable

A high level abstraction over the low level region-based storage API. Acts as a simple database for storing data for keys that are close together/clumped. Example: Key could be an integer location in n-dimensional space, like Minecraft chunk locations. Allows to use fallback region providers for reading and writing, allowing for backwards compatibility when data organization gets changed, or allows to use different storage method for entries not supported by the default IRegion implementation (standard Region implementetion has an upper limit for size)

Constructor Summary

Constructors

Constructor and Description
SaveSection(IRegionProvider<K> regionProvider) Creates a SaveSection with a customized IRegionProvider
SaveSection(java.util.List<IRegionProvider<K>> regionProviders) Creates a SaveSection with a customized IRegionProviders, with each next RegionProvider used as a fallback in case reading/writing is unsuccessful

Method Summary

Modifier and Type	Method and Description
void	close()
void	forAllKeys(CheckedConsumer<? super K,java.io.IOException> cons) Applies the given consumer to all already saved keys.
boolean	hasEntry(K key)
java.util.Optional<java.nio.ByteBuffer>	load(K key, boolean createRegion) Loads/gets a value at a key This Method is thread safe.
void	save(K key, java.nio.ByteBuffer value) Saves/puts a value at a key This method is thread safe.

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveSection

public SaveSection(IRegionProvider<K> regionProvider)

Creates a SaveSection with a customized IRegionProvider

Parameters:

regionProvider - The region provider

SaveSection

public SaveSection(java.util.List<IRegionProvider<K>> regionProviders)

Creates a SaveSection with a customized IRegionProviders, with each next RegionProvider used as a fallback in case reading/writing is unsuccessful

Parameters:

regionProviders - The region providers

Method Detail

save

public void save(K key,
                 java.nio.ByteBuffer value)
          throws java.io.IOException

Saves/puts a value at a key This method is thread safe.

Parameters:

key - The key

value - The value to save

Throws:

java.io.IOException - when an unexpected IO error occurs

load

public java.util.Optional<java.nio.ByteBuffer> load(K key,
                                                    boolean createRegion)
                                             throws java.io.IOException

Loads/gets a value at a key This Method is thread safe.

Parameters:

key - The key

createRegion - if true, a new region file will be created and cached. This is the preferred option.

Returns:

An Optional containing the value if it exists

Throws:

java.io.IOException - when an unexpected IO error occurs

forAllKeys

public void forAllKeys(CheckedConsumer<? super K,java.io.IOException> cons)
                throws java.io.IOException

Applies the given consumer to all already saved keys. Keys saved while this method is running are not guaranteed to be listed. Implementation note: this implementation will sacrifice overall performance for O(1) memory usage in case of many fallback region provider

Parameters:

cons - Consumer that will accept all the existing regions

Throws:

java.io.IOException - when an unexpected IO error occurs

hasEntry

public boolean hasEntry(K key)
                 throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException