io.github.opencubicchunks.cubicchunks.api.util

Class XYZMap<T extends XYZAddressable>

java.lang.Object

io.github.opencubicchunks.cubicchunks.api.util.XYZMap<T>

Type Parameters:

T - class of the objects to be contained in this map

All Implemented Interfaces:

java.lang.Iterable<T>

@ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
public class XYZMap<T extends XYZAddressable>
extends java.lang.Object
implements java.lang.Iterable<T>

Hash table implementation for objects in a 3-dimensional cartesian coordinate system.

See Also:

XYZAddressable

Constructor Summary

Constructors

Constructor and Description
XYZMap(float loadFactor, int capacity) Creates a new XYZMap with the given load factor and initial capacity.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all elements from the map.
boolean	contains(int x, int y, int z) Returns true if there exists an entry associated with the given xyz-coordinates in this map.
boolean	contains(T value) Returns true if the given value is contained within this map.
T	get(int x, int y, int z) Returns the value associated with the given coordinates or null if no such value exists.
int	getSize() Returns the number of elements in this map
java.util.Iterator<T>	iterator()
T	put(T value) Associates the given value with its xyz-coordinates.
java.util.Iterator<T>	randomWrappedIterator(int seed) Return iterator over elements started from random position defined by seed
T	remove(int x, int y, int z) Removes and returns the entry associated with the given coordinates.
T	remove(T value) Removes and returns the given value from this map.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

XYZMap

public XYZMap(float loadFactor,
              int capacity)

Creates a new XYZMap with the given load factor and initial capacity. The map will automatically grow if the specified load is surpassed.

Parameters:

loadFactor - the load factor

capacity - the initial capacity

Method Detail

getSize

public int getSize()

Returns the number of elements in this map

Returns:

the number of elements in this map

clear

public void clear()

Removes all elements from the map.

put

@Nullable
public T put(T value)

Associates the given value with its xyz-coordinates. If the map previously contained a mapping for these coordinates, the old value is replaced.

Parameters:

value - value to be associated with its coordinates

Returns:

the previous value associated with the given value's coordinates or null if no such value exists

remove

@Nullable
public T remove(int x,
                          int y,
                          int z)

Removes and returns the entry associated with the given coordinates.

Parameters:

x - the x-coordinate

y - the y-coordinate

z - the z-coordinate

Returns:

the entry associated with the specified coordinates or null if no such entry exists

remove

@Nullable
public T remove(T value)

Removes and returns the given value from this map. More specifically, removes the entry whose xyz-coordinates equal the given value's coordinates.

Parameters:

value - the value to be removed

Returns:

the entry associated with the given value's coordinates or null if no such entry exists

get

@Nullable
public T get(int x,
                       int y,
                       int z)

Returns the value associated with the given coordinates or null if no such value exists.

Parameters:

x - the x-coordinate

y - the y-coordinate

z - the z-coordinate

Returns:

the entry associated with the specified coordinates or null if no such value exists

contains

public boolean contains(int x,
                        int y,
                        int z)

Returns true if there exists an entry associated with the given xyz-coordinates in this map.

Parameters:

x - the x-coordinate

y - the z-coordinate

z - the y-coordinate

Returns:

true if there exists an entry associated with the given coordinates in this map

contains

public boolean contains(T value)

Returns true if the given value is contained within this map. More specifically, returns true if there exists an entry in this map whose xyz-coordinates equal the given value's coordinates.

Parameters:

value - the value

Returns:

true if the given value is contained within this map

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T extends XYZAddressable>

randomWrappedIterator

public java.util.Iterator<T> randomWrappedIterator(int seed)

Return iterator over elements started from random position defined by seed

Parameters:

seed - defines start position

Returns:

An iterator that starts at randomized position based on seed