eu.wauz.wauzcore.system.util

Class ChunkKeyMap<T>

java.lang.Object

eu.wauz.wauzcore.system.util.ChunkKeyMap<T>

public class ChunkKeyMap<T>
extends java.lang.Object

A tool to map chunks to objects.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,T>	storage

Constructor Summary

Constructors

Constructor and Description
ChunkKeyMap()

Method Summary

Modifier and Type	Method and Description
T	get(org.bukkit.Chunk key) Gets the value, mapped to the given chunk.
static java.lang.String	getChunkKey(org.bukkit.Chunk chunk) Converts the chunk's data into an unique key.
java.util.List<T>	getInRadius(org.bukkit.Chunk key, int radius) Gets all values, mapped to chunks inside the the given radius.
void	put(org.bukkit.Chunk key, T value) Maps a chunk to the given value.
void	remove(org.bukkit.Chunk key) Removes the given chunk and its associated value from the map.

Methods inherited from class java.lang.Object

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

Field Detail

storage

private java.util.Map<java.lang.String,T> storage

Constructor Detail

ChunkKeyMap

public ChunkKeyMap()

Method Detail

put

public void put(org.bukkit.Chunk key,
                T value)

Maps a chunk to the given value.

Parameters:

key - The chunk to use as key.

value - The value.

remove

public void remove(org.bukkit.Chunk key)

Removes the given chunk and its associated value from the map.

Parameters:

key - The chunk to use as key.

get

public T get(org.bukkit.Chunk key)

Gets the value, mapped to the given chunk.

Parameters:

key - The chunk to use as key.

Returns:

The associated value, or null.

getInRadius

public java.util.List<T> getInRadius(org.bukkit.Chunk key,
                                     int radius)

Gets all values, mapped to chunks inside the the given radius.

Parameters:

key - The chunk to use as key for the center.

radius - The radius in chunks, in which values should be found.

Returns:

All found associated values.

getChunkKey

public static java.lang.String getChunkKey(org.bukkit.Chunk chunk)

Converts the chunk's data into an unique key.

Parameters:

chunk - The chunk to get a key to.

Returns:

The key of the chunk.