com.sk89q.worldedit.world.storage

Class ChunkStore

java.lang.Object

com.sk89q.worldedit.world.storage.ChunkStore

Direct Known Subclasses:

LegacyChunkStore, McRegionChunkStore

public abstract class ChunkStore
extends Object

Represents chunk storage mechanisms.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHUNK_SHIFTS >> to chunk << from chunk

Constructor Summary

Constructors

Constructor and Description
ChunkStore()

Method Summary

Modifier and Type	Method and Description
void	close() Close resources.
Chunk	getChunk(Vector2D position, World world) Get a chunk at a location.
abstract CompoundTag	getChunkTag(Vector2D position, World world) Get the tag for a chunk.
abstract boolean	isValid() Returns whether the chunk store is of this type.
static BlockVector2D	toChunk(Vector position) Convert a position to a chunk.

Methods inherited from class java.lang.Object

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

Field Detail

CHUNK_SHIFTS

public static final int CHUNK_SHIFTS

>> to chunk << from chunk

See Also:

Constant Field Values

Constructor Detail

ChunkStore

public ChunkStore()

Method Detail

toChunk

public static BlockVector2D toChunk(Vector position)

Convert a position to a chunk.

Parameters:

position - the position

Returns:

chunk coordinates

getChunkTag

public abstract CompoundTag getChunkTag(Vector2D position,
                                        World world)
                                 throws DataException,
                                        IOException

Get the tag for a chunk.

Parameters:

position - the position of the chunk

Returns:

tag

Throws:

DataException - thrown on data error

IOException - thrown on I/O error

getChunk

public Chunk getChunk(Vector2D position,
                      World world)
               throws DataException,
                      IOException

Get a chunk at a location.

Parameters:

position - the position of the chunk

Returns:

a chunk

Throws:

ChunkStoreException - thrown if there is an error from the chunk store

DataException - thrown on data error

IOException - thrown on I/O error

close

public void close()
           throws IOException

Close resources.

Throws:

IOException - on I/O error

isValid

public abstract boolean isValid()

Returns whether the chunk store is of this type.

Returns:

true if valid