cubicchunks.regionlib.api.region

Interface IRegion<K extends IKey<K>>

Type Parameters:

K - The IKey type

All Superinterfaces:

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

All Known Implementing Classes:

ExtRegion, Region

public interface IRegion<K extends IKey<K>>
extends java.io.Flushable, java.io.Closeable

The low level storage for data, represents it's logical organization. Different regions may not necessarily correspong to different files, and a region may be backed by more than one file. A region can store a constant, known amount of entries, specified by IKeyProvider. Stores all values within a fixed measure (usually area or volume) of keys (locations). Regions are used as a way of *chunking* the database.

Method Summary

Modifier and Type	Method and Description
void	forEachKey(CheckedConsumer<? super K,java.io.IOException> cons) Applies the consumer to all existing region keys
boolean	hasValue(K key) Returns true if something was stored there before within this region.
java.util.Optional<java.nio.ByteBuffer>	readValue(K key) Loads a value at a key if there was something stored there before, within this region
void	writeSpecial(K key, java.lang.Object marker)
void	writeValue(K key, java.nio.ByteBuffer value) Stores a value at a key within this region
default void	writeValues(java.util.Map<K,java.nio.ByteBuffer> entries) Stores multiple values at their corresponding keys within this region

Methods inherited from interface java.io.Flushable

flush

Methods inherited from interface java.io.Closeable

close

Method Detail

writeValue

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

Stores a value at a key within this region

Parameters:

key - A key within this region

value - The value to store. Null to remove existing value.

Throws:

UnsupportedDataException - if the data cannot be written due to internal constraints of the storage format. The stored data must remain unchanged after this exception is thrown

java.io.IOException

writeValues

default void writeValues(java.util.Map<K,java.nio.ByteBuffer> entries)
                  throws java.io.IOException

Stores multiple values at their corresponding keys within this region

Parameters:

entries - the key-value pairs to store. A value of null will remove an existing value

Throws:

MultiUnsupportedDataException - if the data cannot be written due to internal constraints of the storage format. The exception contains all of the keys whose values failed to be written, and stored data for failed key-value pairs must remain unchanged

java.io.IOException

writeSpecial

void writeSpecial(K key,
                  java.lang.Object marker)
           throws java.io.IOException

Throws:

java.io.IOException

readValue

java.util.Optional<java.nio.ByteBuffer> readValue(K key)
                                           throws java.io.IOException

Loads a value at a key if there was something stored there before, within this region

Parameters:

key - The key within this region

Returns:

The value at key if it exists

Throws:

java.io.IOException

hasValue

boolean hasValue(K key)

Returns true if something was stored there before within this region.

forEachKey

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

Applies the consumer to all existing region keys

Throws:

java.io.IOException