cubicchunks.regionlib.impl

Class EntryLocation2D.Provider

java.lang.Object

cubicchunks.regionlib.impl.EntryLocation2D.Provider

All Implemented Interfaces:

IKeyProvider<EntryLocation2D>

Enclosing class:

EntryLocation2D

public static class EntryLocation2D.Provider
extends java.lang.Object
implements IKeyProvider<EntryLocation2D>

Constructor Summary

Constructors

Constructor and Description
Provider()

Method Summary

Modifier and Type	Method and Description
EntryLocation2D	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)

Methods inherited from class java.lang.Object

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

Constructor Detail

Provider

public Provider()

Method Detail

fromRegionAndId

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

Description copied from interface: IKeyProvider

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.

Specified by:

fromRegionAndId in interface IKeyProvider<EntryLocation2D>

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

public int getKeyCount(RegionKey key)

Description copied from interface: IKeyProvider

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)

Specified by:

getKeyCount in interface IKeyProvider<EntryLocation2D>

Parameters:

key - the region key

Returns:

The number of keys in this region

isValid

public boolean isValid(RegionKey key)

Specified by:

isValid in interface IKeyProvider<EntryLocation2D>