io.github.opencubicchunks.cubicchunks.core.server.chunkio

Class RegionCubeStorage

java.lang.Object

io.github.opencubicchunks.cubicchunks.core.server.chunkio.RegionCubeStorage

All Implemented Interfaces:

ICubicStorage, java.io.Flushable, java.lang.AutoCloseable

public class RegionCubeStorage
extends java.lang.Object
implements ICubicStorage

Implementation of ICubicStorage for the Cubic Chunks' standard Anvil3d storage format.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.opencubicchunks.cubicchunks.api.world.storage.ICubicStorage

ICubicStorage.NBTBatch, ICubicStorage.PosBatch

Constructor Summary

Constructors

Constructor and Description
RegionCubeStorage(java.nio.file.Path path)

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.
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.
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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.opencubicchunks.cubicchunks.api.world.storage.ICubicStorage

existsBatch, readBatch

Constructor Detail

RegionCubeStorage

public RegionCubeStorage(java.nio.file.Path path)
                  throws java.io.IOException

Throws:

java.io.IOException

Method Detail

columnExists

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

Description copied from interface: ICubicStorage

Checks whether the column at the given position exists.

Specified by:

columnExists in interface ICubicStorage

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

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

Description copied from interface: ICubicStorage

Checks whether the cube at the given position exists.

Specified by:

cubeExists in interface ICubicStorage

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

readColumn

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

Description copied from interface: ICubicStorage

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

Specified by:

readColumn in interface ICubicStorage

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

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

Description copied from interface: ICubicStorage

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

Specified by:

readCube in interface ICubicStorage

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

writeColumn

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

Description copied from interface: ICubicStorage

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

Specified by:

writeColumn in interface ICubicStorage

Parameters:

pos - the column's position

nbt - the column's NBT data

Throws:

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

writeCube

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

Description copied from interface: ICubicStorage

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

Specified by:

writeCube in interface ICubicStorage

Parameters:

pos - the cube's position

nbt - the cube's NBT data

Throws:

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

writeBatch

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

Description copied from interface: ICubicStorage

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

Specified by:

writeBatch in interface ICubicStorage

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

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

Description copied from interface: ICubicStorage

Iterates over all the columns that exist in the world.

Specified by:

forEachColumn in interface ICubicStorage

Parameters:

callback - the callback function to run

Throws:

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

forEachCube

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

Description copied from interface: ICubicStorage

Iterates over all the cubes that exist in the world.

Specified by:

forEachCube in interface ICubicStorage

Parameters:

callback - the callback function to run

Throws:

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

flush

public void flush()
           throws java.io.IOException

Description copied from interface: ICubicStorage

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 ICubicStorage

Specified by:

flush in interface java.io.Flushable

Throws:

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

close

public void close()
           throws java.io.IOException

Description copied from interface: ICubicStorage

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 ICubicStorage

Specified by:

close in interface java.lang.AutoCloseable

Throws:

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