io.github.opencubicchunks.cubicchunks.api.world.storage

Interface ICubicStorage

All Superinterfaces:

java.lang.AutoCloseable, java.io.Flushable

@ParametersAreNonnullByDefault
public interface ICubicStorage
extends java.io.Flushable, java.lang.AutoCloseable

Representation of a storage format driver for Cubic Chunks worlds.

Implementations of this class must be thread-safe.

Unless otherwise specified by the implementation, absolutely NO atomicity guarantees are made whatsoever.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ICubicStorage.NBTBatch A group of position+NBT data pairs for both column and cube data.
static class	ICubicStorage.PosBatch A group of positions for both columns and cubes.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this storage.
boolean	columnExists(net.minecraft.util.math.ChunkPos pos) Checks whether the column at the given position exists.
boolean	cubeExists(CubePos pos) Checks whether the cube at the given position exists.
default ICubicStorage.PosBatch	existsBatch(ICubicStorage.PosBatch positions) Checks for the existence of multiple cubes+columns at once.
void	flush() Forces any internally buffered data to be written to disk immediately, blocking until the action is completed.
void	forEachColumn(java.util.function.Consumer<net.minecraft.util.math.ChunkPos> callback) Iterates over all the columns that exist in the world.
void	forEachCube(java.util.function.Consumer<CubePos> callback) Iterates over all the cubes that exist in the world.
default ICubicStorage.NBTBatch	readBatch(ICubicStorage.PosBatch positions) Reads the NBT data for multiple cubes+columns at once.
net.minecraft.nbt.NBTTagCompound	readColumn(net.minecraft.util.math.ChunkPos pos) Reads the NBT data for the column at the given position.
net.minecraft.nbt.NBTTagCompound	readCube(CubePos pos) Reads the NBT data for the cube at the given position.
default void	writeBatch(ICubicStorage.NBTBatch batch) Writes the NBT data for multiple cubes+columns at once.
void	writeColumn(net.minecraft.util.math.ChunkPos pos, net.minecraft.nbt.NBTTagCompound nbt) Writes the NBT data to the column at the given position.
void	writeCube(CubePos pos, net.minecraft.nbt.NBTTagCompound nbt) Writes the NBT data to the cube at the given position.

Method Detail

columnExists

boolean columnExists(net.minecraft.util.math.ChunkPos pos)
              throws java.io.IOException

Checks whether the column at the given position exists.

Parameters:

pos - the column's position

Returns:

whether the column at the given position exists

Throws:

java.io.IOException - if there is an IO error

cubeExists

boolean cubeExists(CubePos pos)
            throws java.io.IOException

Checks whether the cube at the given position exists.

Parameters:

pos - the cube's position

Returns:

whether the cube at the given position exists

Throws:

java.io.IOException - if there is an IO error

existsBatch

@Nonnull
default ICubicStorage.PosBatch existsBatch(ICubicStorage.PosBatch positions)
                                             throws java.io.IOException

Checks for the existence of multiple cubes+columns at once.

Parameters:

positions - a ICubicStorage.PosBatch containing the positions of all the cubes+columns to check for

Returns:

a ICubicStorage.PosBatch containing the positions of all the cubes+columns that exist

Throws:

java.io.IOException - if there is an IO error

readColumn

net.minecraft.nbt.NBTTagCompound readColumn(net.minecraft.util.math.ChunkPos pos)
                                     throws java.io.IOException

Reads the NBT data for the column at the given position.

Parameters:

pos - the column's position

Returns:

the column's NBT data, or null if the column couldn't be found

Throws:

java.io.IOException - if there is an IO error

readCube

net.minecraft.nbt.NBTTagCompound readCube(CubePos pos)
                                   throws java.io.IOException

Reads the NBT data for the cube at the given position.

Parameters:

pos - the cube's position

Returns:

the cube's NBT data, or null if the cube couldn't be found

Throws:

java.io.IOException - if there is an IO error

readBatch

@Nonnull
default ICubicStorage.NBTBatch readBatch(ICubicStorage.PosBatch positions)
                                           throws java.io.IOException

Reads the NBT data for multiple cubes+columns at once.

Parameters:

positions - a ICubicStorage.PosBatch containing the positions of all the cubes+columns to read

Returns:

a ICubicStorage.NBTBatch containing all the given cube+column positions mapped to their corresponding NBT data, or null for cubes/columns that can't be found

Throws:

java.io.IOException - if there is an IO error

writeColumn

void writeColumn(net.minecraft.util.math.ChunkPos pos,
                 net.minecraft.nbt.NBTTagCompound nbt)
          throws java.io.IOException

Writes the NBT data to the column at the given position.

Parameters:

pos - the column's position

nbt - the column's NBT data

Throws:

java.io.IOException - if there is an IO error

writeCube

void writeCube(CubePos pos,
               net.minecraft.nbt.NBTTagCompound nbt)
        throws java.io.IOException

Writes the NBT data to the cube at the given position.

Parameters:

pos - the cube's position

nbt - the cube's NBT data

Throws:

java.io.IOException - if there is an IO error

writeBatch

default void writeBatch(ICubicStorage.NBTBatch batch)
                 throws java.io.IOException

Writes the NBT data for multiple cubes+columns at once.

Parameters:

batch - a ICubicStorage.NBTBatch containing the cube+column positions and the NBT data to write to each

Throws:

java.io.IOException - if there is an IO error

forEachColumn

void forEachColumn(java.util.function.Consumer<net.minecraft.util.math.ChunkPos> callback)
            throws java.io.IOException

Iterates over all the columns that exist in the world.

Parameters:

callback - the callback function to run

Throws:

java.io.IOException - if there is an IO error

forEachCube

void forEachCube(java.util.function.Consumer<CubePos> callback)
          throws java.io.IOException

Iterates over all the cubes that exist in the world.

Parameters:

callback - the callback function to run

Throws:

java.io.IOException - if there is an IO error

flush

void flush()
    throws java.io.IOException

Forces any internally buffered data to be written to disk immediately, blocking until the action is completed.

Once this method returns, all writes issued at the time of this method's invocation are guaranteed to be present on disk.

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException - if there is an IO error

close

void close()
    throws java.io.IOException

Closes this storage.

This method may only be called once for a given of ICubicStorage. Once called, the instance shall be considered to have been disposed, and the behavior of all other methods is undefined.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if there is an IO error