org.pepsoft.worldpainter.exporting

Class JavaChunkStore

java.lang.Object

org.pepsoft.worldpainter.exporting.JavaChunkStore

All Implemented Interfaces:

java.lang.AutoCloseable, ChunkProvider, ChunkStore

public class JavaChunkStore
extends java.lang.Object
implements ChunkStore

Created by Pepijn on 15-12-2016.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JavaChunkStore.RegionVisitor

Nested classes/interfaces inherited from interface org.pepsoft.minecraft.ChunkStore

ChunkStore.ChunkVisitor

Constructor Summary

Constructors

Constructor and Description
JavaChunkStore(Platform platform, java.io.File regionDir, int minHeight, int maxHeight)

Method Summary

Modifier and Type	Method and Description
void	close() Close the chunk provider, flushing any changes and closing any system resources.
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() Saves all dirty chunks and closes all files.
Chunk	getChunk(int x, int z) Load a chunk.
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.
Chunk	getChunkForEditing(int x, int z) Load a chunk.
boolean	isChunkPresent(int x, int z) Determine whether a chunk is present.
static void	main(java.lang.String[] args)
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.
boolean	visitRegions(JavaChunkStore.RegionVisitor visitor, boolean readOnly, java.lang.String operation, java.util.Set<DataType> dataTypes)

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaChunkStore

public JavaChunkStore(Platform platform,
                      java.io.File regionDir,
                      int minHeight,
                      int maxHeight)

Method Detail

visitRegions

public boolean visitRegions(JavaChunkStore.RegionVisitor visitor,
                            boolean readOnly,
                            java.lang.String operation,
                            java.util.Set<DataType> dataTypes)
                     throws java.io.IOException

Throws:

java.io.IOException

getChunkCount

public int getChunkCount()

Description copied from interface: ChunkStore

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

Specified by:

getChunkCount in interface ChunkStore

Returns:

The count of all the chunks currently in the store.

getChunkCoords

public java.util.Set<MinecraftCoords> getChunkCoords()

Description copied from interface: ChunkStore

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.

Specified by:

getChunkCoords in interface ChunkStore

Returns:

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

visitChunks

public boolean visitChunks(ChunkStore.ChunkVisitor visitor)

Description copied from interface: ChunkStore

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.

Specified by:

visitChunks in interface ChunkStore

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

public boolean visitChunksForEditing(ChunkStore.ChunkVisitor visitor)

Description copied from interface: ChunkStore

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

Specified by:

visitChunksForEditing in interface ChunkStore

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

public void saveChunk(Chunk chunk)

Description copied from interface: ChunkStore

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

Specified by:

saveChunk in interface ChunkStore

Parameters:

chunk - The chunk to save.

doInTransaction

public void doInTransaction(java.lang.Runnable task)

Description copied from interface: ChunkStore

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

Specified by:

doInTransaction in interface ChunkStore

Parameters:

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

flush

public void flush()

Saves all dirty chunks and closes all files. Ensures that all changes are saved and no system resources are being used, but the objects can still be used; any subsequent operations will open files as needed again.

Specified by:

flush in interface ChunkStore

isChunkPresent

public boolean isChunkPresent(int x,
                              int z)

Description copied from interface: ChunkProvider

Determine whether a chunk is present.

Specified by:

isChunkPresent in interface ChunkProvider

Parameters:

x - The X coordinate to check.

z - The Z coordinate to check.

Returns:

true if the chunk provider contains a chunk at the specified coordinates.

getChunk

public Chunk getChunk(int x,
                      int z)

Load a chunk. Returns null if the chunk does not exist in the map.

Specified by:

getChunk in interface ChunkProvider

Parameters:

x - The X coordinate in the Minecraft coordinate system of the chunk to load.

z - The Z coordinate in the Minecraft coordinate system of the chunk to load.

Returns:

The specified chunk, or null if the chunk does not exist in the map.

getChunkForEditing

public Chunk getChunkForEditing(int x,
                                int z)

Load a chunk. Returns null if the chunk does not exist in the map.

Specified by:

getChunkForEditing in interface ChunkProvider

Parameters:

x - The X coordinate in the Minecraft coordinate system of the chunk to load.

z - The Z coordinate in the Minecraft coordinate system of the chunk to load.

Returns:

The specified chunk, or null if the chunk does not exist in the map.

close

public void close()

Description copied from interface: ChunkProvider

Close the chunk provider, flushing any changes and closing any system resources.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface ChunkProvider

main

public static void main(java.lang.String[] args)