cubicchunks.regionlib.impl

Class EntryLocation2D

java.lang.Object

cubicchunks.regionlib.impl.EntryLocation2D

All Implemented Interfaces:

IKey<EntryLocation2D>

public class EntryLocation2D
extends java.lang.Object
implements IKey<EntryLocation2D>

A 2D implementation of IEntryLocation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntryLocation2D.Provider

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENTRIES_PER_REGION
static int	LOC_BITMASK
static int	LOC_BITS

Constructor Summary

Constructors

Constructor and Description
EntryLocation2D(int entryX, int entryZ)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	getEntryX()
int	getEntryZ()
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.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOC_BITS

public static final int LOC_BITS

See Also:

Constant Field Values

LOC_BITMASK

public static final int LOC_BITMASK

See Also:

Constant Field Values

ENTRIES_PER_REGION

public static final int ENTRIES_PER_REGION

See Also:

Constant Field Values

Constructor Detail

EntryLocation2D

public EntryLocation2D(int entryX,
                       int entryZ)

Method Detail

getEntryX

public int getEntryX()

getEntryZ

public int getEntryZ()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRegionKey

public RegionKey getRegionKey()

Description copied from interface: IKey

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.

Specified by:

getRegionKey in interface IKey<EntryLocation2D>

Returns:

This region's key

getId

public int getId()

Description copied from interface: IKey

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.

Specified by:

getId in interface IKey<EntryLocation2D>

Returns:

The index

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object