cubicchunks.regionlib.lib

Class Region<K extends IKey<K>>

java.lang.Object

cubicchunks.regionlib.lib.Region<K>

Type Parameters:

K - The key type

All Implemented Interfaces:

IRegion<K>, java.io.Closeable, java.lang.AutoCloseable

public class Region<K extends IKey<K>>
extends java.lang.Object
implements IRegion<K>

A basic region implementation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Region.Builder<K extends IKey<K>> Internal Region builder.

Method Summary

Modifier and Type	Method and Description
static <L extends IKey<L>> Region.Builder<L>	builder()
void	close()
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

Methods inherited from class java.lang.Object

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

Method Detail

writeValue

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

Description copied from interface: IRegion

Stores a value at a key within this region

Specified by:

writeValue in interface IRegion<K extends IKey<K>>

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

writeSpecial

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

Specified by:

writeSpecial in interface IRegion<K extends IKey<K>>

Throws:

java.io.IOException

readValue

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

Description copied from interface: IRegion

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

Specified by:

readValue in interface IRegion<K extends IKey<K>>

Parameters:

key - The key within this region

Returns:

The value at key if it exists

Throws:

java.io.IOException

hasValue

public boolean hasValue(K key)

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

Specified by:

hasValue in interface IRegion<K extends IKey<K>>

forEachKey

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

Description copied from interface: IRegion

Applies the consumer to all existing region keys

Specified by:

forEachKey in interface IRegion<K extends IKey<K>>

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

builder

public static <L extends IKey<L>> Region.Builder<L> builder()