cubicchunks.regionlib.api.region.key

Interface IKey<K extends IKey<K>>

Type Parameters:

K - This type

All Known Implementing Classes:

EntryLocation2D, EntryLocation3D, MinecraftChunkLocation

public interface IKey<K extends IKey<K>>

Specifies a logical location of a chunk of data (ByteBuffer), and maps the logical location to the region it's stored in (RegionKey), and logical location inside the region (ID). This class should be immutable.

Method Summary

Modifier and Type	Method and Description
int	getId() Gets the index of this key in the region associated with this region location The index must be grater than or equal to 0 AND less than IKeyProvider.getKeyCount(RegionKey).
RegionKey	getRegionKey() Gets the region's key.

Method Detail

getId

int getId()

Gets the index of this key in the region associated with this region location The index must be grater than or equal to 0 AND less than IKeyProvider.getKeyCount(RegionKey). The index must be unique within one region. Specifically, for any 2 IKey objects of the same type, k1.getRegionKey().equals(k2.getRegionKey()) && k1.getId() != k2.getId() must always be true.

Returns:

The index

getRegionKey

RegionKey getRegionKey()

Gets the region's key. The name may be used as a file name, so names not matching ^[a-z0-9\._\-]+$ are not supported. Uppercase characters are not allowed to avoid case-sensitivity issues across different operating systems.

Returns:

This region's key