org.pepsoft.minecraft

Interface ChunkStore

All Superinterfaces:

java.lang.AutoCloseable, ChunkProvider

All Known Implementing Classes:

JavaChunkStore

public interface ChunkStore
extends ChunkProvider

A provider of Minecraft chunk storage.

Created by Pepijn on 14-12-2016.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ChunkStore.ChunkVisitor A visitor of chunks.

Method Summary

Modifier and Type	Method and Description
void	doInTransaction(java.lang.Runnable task) Run a task, for example saving more than one chunk, in one transaction against the chunk store, which may improve performance.
void	flush() Make sure all previously saved chunks are written to disk.
java.util.Set<MinecraftCoords>	getChunkCoords() Returns the coordinates of all the chunks that currently exist in the store.
int	getChunkCount() Return a total count of all the chunks currently in the store.
void	saveChunk(Chunk chunk) Save a chunk to the store.
boolean	visitChunks(ChunkStore.ChunkVisitor visitor) Visit all known chunks.
boolean	visitChunksForEditing(ChunkStore.ChunkVisitor visitor) Visit all known chunks for editing.

Methods inherited from interface org.pepsoft.minecraft.ChunkProvider

close, getChunk, getChunkForEditing, isChunkPresent

Method Detail

getChunkCount

int getChunkCount()

Return a total count of all the chunks currently in the store.

Returns:

The count of all the chunks currently in the store.

getChunkCoords

java.util.Set<MinecraftCoords> getChunkCoords()

Returns the coordinates of all the chunks that currently exist in the store. This is intended to be more efficient and faster than actually visiting all the chunks for use cases where only the existence and/or coordinates are needed.

Returns:

A set of the coordinates of all the chunks that currently exist in the store.

visitChunks

boolean visitChunks(ChunkStore.ChunkVisitor visitor)

Visit all known chunks.

Note that the order is undefined, allowing the provider to use as efficient an implementation as is possible. The provided chunks may be read-only.

Also note that to improve performance the process may be parallelised. In other words the visitor may be invoked concurrently for different chunks and must therefore be thread-safe. It also means that if the visitor returns false, the iteration may not stop immediately.

Parameters:

visitor - The visitor to invoke for each chunk.

Returns:

true if all chunks were visited; false if not all chunks may have been visited because the visitor returned false.

visitChunksForEditing

boolean visitChunksForEditing(ChunkStore.ChunkVisitor visitor)

Visit all known chunks for editing. Note that the order is undefined, allowing the provider to use as efficient an implementation as is possible. The provided chunks are guaranteed not to be read-only, and are saved to the chunk store after the visitor returns true (regardless of whether the visitor modified the chunk).

Parameters:

visitor - The visitor to invoke for each chunk.

Returns:

true if all chunks were visited; false if not all chunks may have been visited because the visitor returned false.

saveChunk

void saveChunk(Chunk chunk)

Save a chunk to the store. The chunk is only guaranteerd to have been written to disk if this operation was performed inside a doInTransaction(Runnable), or after flush() has been called.

Parameters:

chunk - The chunk to save.

doInTransaction

void doInTransaction(java.lang.Runnable task)

Run a task, for example saving more than one chunk, in one transaction against the chunk store, which may improve performance.

Parameters:

task - The task to execute in one chunk store transaction.

flush

void flush()

Make sure all previously saved chunks are written to disk. Not necessary for chunks which have been saved inside a doInTransaction(Runnable).