io.github.bananapuncher714.cartographer.core.file

Class BigChunkQueue

java.lang.Object

io.github.bananapuncher714.cartographer.core.file.BigChunkQueue

public class BigChunkQueue
extends java.lang.Object

Save and load BigChunk asynchronously.

Author:

BananaPuncher714

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BigChunkQueue.TaskChunkLoad Responsible for loading chunks.
protected class	BigChunkQueue.TaskChunkSave Responsible for saving chunks.

Field Summary

Fields

Modifier and Type	Field and Description
protected MapDataCache	cache
protected java.util.Map<BigChunkLocation,java.util.concurrent.Future<BigChunk>>	loading
protected java.util.concurrent.ExecutorService	loadingService
protected java.io.File	saveLocation
protected java.util.Map<BigChunkLocation,java.util.concurrent.Future<java.lang.Boolean>>	saving
protected java.util.concurrent.ExecutorService	savingService

Constructor Summary

Constructors

Constructor and Description
BigChunkQueue(java.io.File saveFile, MapDataCache cache) Construct a BigChunkQueue from the arguments provided.

Method Summary

Modifier and Type	Method and Description
protected java.io.File	getFileFor(BigChunkLocation coord) Get the file for the BigChunkLocation.
boolean	isLoading(ChunkLocation location)
boolean	isSaving(ChunkLocation location)
void	load(BigChunkLocation coord) Load the BigChunkLocation as soon as possible.
boolean	save(BigChunkLocation coord, BigChunk data) Save the data as soon as possible, if not being already saved or loaded.
boolean	saveBlocking() Shutdown loading and saving services, and finish saving what needs to be saved on the main thread.
void	update() Should be called each tick or so often by whatever is responsible for this to use the data that has been loaded, and request processing for what has not.

Methods inherited from class java.lang.Object

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

Field Detail

savingService

protected final java.util.concurrent.ExecutorService savingService

loadingService

protected final java.util.concurrent.ExecutorService loadingService

loading

protected java.util.Map<BigChunkLocation,java.util.concurrent.Future<BigChunk>> loading

saving

protected java.util.Map<BigChunkLocation,java.util.concurrent.Future<java.lang.Boolean>> saving

cache

protected MapDataCache cache

saveLocation

protected java.io.File saveLocation

Constructor Detail

BigChunkQueue

public BigChunkQueue(java.io.File saveFile,
                     MapDataCache cache)

Construct a BigChunkQueue from the arguments provided.

Parameters:

saveFile - The directory to save BigChunk in. Cannot be null.

cache - The MapDataCache containing the data. Cannot be null.

Method Detail

save

public boolean save(BigChunkLocation coord,
                    BigChunk data)

Save the data as soon as possible, if not being already saved or loaded.

Parameters:

coord - The BigChunkLocation of the data, cannot be null.

data - The BigChunk to save, cannot be null.

Returns:

If successfully queued for saving.

saveBlocking

public boolean saveBlocking()

Shutdown loading and saving services, and finish saving what needs to be saved on the main thread.

Returns:

If shutting down was successful.

load

public void load(BigChunkLocation coord)

Load the BigChunkLocation as soon as possible.

Parameters:

coord - The BigChunkLocation to load, cannot be null.

update

public void update()

Should be called each tick or so often by whatever is responsible for this to use the data that has been loaded, and request processing for what has not.

isSaving

public boolean isSaving(ChunkLocation location)

isLoading

public boolean isLoading(ChunkLocation location)

getFileFor

protected java.io.File getFileFor(BigChunkLocation coord)

Get the file for the BigChunkLocation.

Parameters:

coord - The coordinate of the BigChunkLocation, cannot be null.

Returns:

Normally stored in 'base/world/x/z/' form.