cubicchunks.regionlib.api.region.key

Interface IKeyProvider<K extends IKey<K>>

All Known Implementing Classes:

EntryLocation2D.Provider, EntryLocation3D.Provider, MinecraftChunkLocation.Provider

public interface IKeyProvider<K extends IKey<K>>

Provides metadata about keys and allows creating keys by region name.

Method Summary

Modifier and Type	Method and Description
K	fromRegionAndId(RegionKey regionKey, int id) Creates instance of K such that key.getRegionKey().equals(regionKey) && key.getId() == id, or throws IllegalArgumentException when the region key and id pair doesn't represent any key of this type.
int	getKeyCount(RegionKey key) Gets the maximum number of keys within the region.
boolean	isValid(RegionKey key)

Method Detail

fromRegionAndId

K fromRegionAndId(RegionKey regionKey,
                  int id)
           throws java.lang.IllegalArgumentException

Creates instance of K such that key.getRegionKey().equals(regionKey) && key.getId() == id, or throws IllegalArgumentException when the region key and id pair doesn't represent any key of this type.

Parameters:

regionKey - the RegionKey for which an IKey should be created

id - the ID for which an IKey should be created

Returns:

the newly created key

Throws:

java.lang.IllegalArgumentException - when the supplied regionKey and id pair doesn't correspond to a valid key of type K.

getKeyCount

int getKeyCount(RegionKey key)

Gets the maximum number of keys within the region. The number must be constant within one region (where the same value for getRegionKey is returned)

Parameters:

key - the region key

Returns:

The number of keys in this region

isValid

boolean isValid(RegionKey key)