org.spongepowered.api.world.storage

Interface ChunkDataStream

public interface ChunkDataStream

A chunk iterator represents a buffer for obtaining chunk data from storage without having to explicitly load into memory all available chunks.

This avoid loading all chunks into memory at once, reducing the memory footprint and persistence operations.

The chunks are loaded individually in sequence. Strong references to the chunks represented by DataContainers should be avoided AT ALL COSTS. The data represented is a copy and therefore shouldn't be considered synchronized to live data.

This is a data stream from the chunk storage system and should be used in an asynchronous thread from the main thread.

Method Summary

Modifier and Type	Method and Description
int	available() Gets the number of chunks available to read as DataContainers.
boolean	hasNext() Checks if there is an available chunk to represent.
DataContainer	next() Gets the next Chunk represented by a read only DataContainer.
void	reset() Resets this stream to read from the beginning of the collection of chunks.

Method Detail

next

@Nullable
DataContainer next()

Gets the next Chunk represented by a read only DataContainer.

This method BLOCKS the thread until the next available data has been read.

This may not return a DataContainer in the event there is no chunk data available to read.

Returns:

The chunk data represented by a data container

hasNext

boolean hasNext()

Checks if there is an available chunk to represent.

Returns:

Whether there is more data that can be read

available

int available()

Gets the number of chunks available to read as DataContainers.

Returns:

The number of remaining chunks available to read

reset

void reset()

Resets this stream to read from the beginning of the collection of chunks.