cubicchunks.regionlib.impl

Class SaveCubeColumns

java.lang.Object

cubicchunks.regionlib.impl.SaveCubeColumns

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class SaveCubeColumns
extends java.lang.Object
implements java.io.Closeable

A save for 3d and 2d structures, like Cubes and Columns in CubicChunks.

Constructor Summary

Constructors

Constructor and Description
SaveCubeColumns(SaveSection2D saveSection2D, SaveSection3D saveSection3D)

Method Summary

Modifier and Type	Method and Description
void	close()
static SaveCubeColumns	create(java.nio.file.Path directory)
SaveSection2D	getSaveSection2D()
SaveSection3D	getSaveSection3D()
java.util.Optional<java.nio.ByteBuffer>	load(EntryLocation2D location, boolean createRegion) Reads entry at given location.
java.util.Optional<java.nio.ByteBuffer>	load(EntryLocation3D location, boolean createRegion) Reads entry at given location.
void	save2d(EntryLocation2D location, java.nio.ByteBuffer data) Schedules entry for writing This can be accessed from multiple threads.
void	save3d(EntryLocation3D location, java.nio.ByteBuffer data) Schedules entry for writing This can be accessed from multiple threads.

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveCubeColumns

public SaveCubeColumns(SaveSection2D saveSection2D,
                       SaveSection3D saveSection3D)

Method Detail

getSaveSection2D

public SaveSection2D getSaveSection2D()

getSaveSection3D

public SaveSection3D getSaveSection3D()

save3d

public void save3d(EntryLocation3D location,
                   java.nio.ByteBuffer data)
            throws java.io.IOException

Schedules entry for writing This can be accessed from multiple threads. (thread safe)

Parameters:

location - location of the entry

data - the entry data to be saved

Throws:

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

save2d

public void save2d(EntryLocation2D location,
                   java.nio.ByteBuffer data)
            throws java.io.IOException

Schedules entry for writing This can be accessed from multiple threads. (thread safe)

Parameters:

location - location of the entry

data - the entry data to be saved

Throws:

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

load

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

Reads entry at given location. This can be accessed from multiple threads. (thread safe)

Parameters:

location - the location of the entry data to load

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

load

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

Reads entry at given location.

This can be accessed from multiple threads. (thread safe)

Parameters:

location - the location of the entry data to load

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

create

public static SaveCubeColumns create(java.nio.file.Path directory)
                              throws java.io.IOException

Parameters:

directory - directory for the save

Throws:

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

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