com.comphenix.protocol.concurrency

Class ConcurrentPlayerMap<TValue>

java.lang.Object

java.util.AbstractMap<org.bukkit.entity.Player,TValue>

com.comphenix.protocol.concurrency.ConcurrentPlayerMap<TValue>

All Implemented Interfaces:

java.util.concurrent.ConcurrentMap<org.bukkit.entity.Player,TValue>, java.util.Map<org.bukkit.entity.Player,TValue>

public class ConcurrentPlayerMap<TValue>
extends java.util.AbstractMap<org.bukkit.entity.Player,TValue>
implements java.util.concurrent.ConcurrentMap<org.bukkit.entity.Player,TValue>

Represents a concurrent player map.

This map may use player addresses as keys.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConcurrentPlayerMap.PlayerKey Represents the different standard player keys,

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ConcurrentMap<java.lang.Object,org.bukkit.entity.Player>	keyLookup A cache of the associated keys for each player.
protected com.google.common.base.Function<org.bukkit.entity.Player,java.lang.Object>	keyMethod The method used to retrieve a unique key for a player.
protected java.util.concurrent.ConcurrentMap<java.lang.Object,TValue>	valueLookup An internal map of player keys to values.

Constructor Summary

Constructors

Constructor and Description
ConcurrentPlayerMap(ConcurrentPlayerMap.PlayerKey standardMethod) Construct a new concurrent player map using the given standard key method.
ConcurrentPlayerMap(com.google.common.base.Function<org.bukkit.entity.Player,java.lang.Object> method) Construct a new concurrent player map using the given custom key method.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.Object	cachePlayerKey(org.bukkit.entity.Player player) Retrieve the key of a particular player, ensuring it is cached.
boolean	containsKey(java.lang.Object key)
protected java.util.concurrent.ConcurrentMap<java.lang.Object,org.bukkit.entity.Player>	createKeyCache() Construct a cache of keys and the associated player.
protected java.util.concurrent.ConcurrentMap<java.lang.Object,TValue>	createValueMap() Construct the map that will store the associated values.
java.util.Set<java.util.Map.Entry<org.bukkit.entity.Player,TValue>>	entrySet()
protected org.bukkit.entity.Player	findOnlinePlayer(java.lang.Object key) Find an online player from the given key.
TValue	get(java.lang.Object key)
protected org.bukkit.entity.Player	lookupPlayer(java.lang.Object key) Lookup a player by key in the cache, optionally searching every online player.
TValue	put(org.bukkit.entity.Player key, TValue value)
TValue	putIfAbsent(org.bukkit.entity.Player key, TValue value)
TValue	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
TValue	replace(org.bukkit.entity.Player key, TValue value)
boolean	replace(org.bukkit.entity.Player key, TValue oldValue, TValue newValue)
static <T> ConcurrentPlayerMap<T>	usingAddress() Construct a new concurrent player map that uses each player's address as key.
static <T> ConcurrentPlayerMap<T>	usingName() Construct a new concurrent player map that uses each player's name as key.

Methods inherited from class java.util.AbstractMap

clear, clone, containsValue, equals, hashCode, isEmpty, keySet, putAll, size, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

clear, containsValue, equals, hashCode, isEmpty, keySet, putAll, size, values

Field Detail

valueLookup

protected java.util.concurrent.ConcurrentMap<java.lang.Object,TValue> valueLookup

An internal map of player keys to values.

keyLookup

protected java.util.concurrent.ConcurrentMap<java.lang.Object,org.bukkit.entity.Player> keyLookup

A cache of the associated keys for each player.

keyMethod

protected final com.google.common.base.Function<org.bukkit.entity.Player,java.lang.Object> keyMethod

The method used to retrieve a unique key for a player.

Constructor Detail

ConcurrentPlayerMap

public ConcurrentPlayerMap(ConcurrentPlayerMap.PlayerKey standardMethod)

Construct a new concurrent player map using the given standard key method.

Parameters:

standardMethod - - the standard key method.

ConcurrentPlayerMap

public ConcurrentPlayerMap(com.google.common.base.Function<org.bukkit.entity.Player,java.lang.Object> method)

Construct a new concurrent player map using the given custom key method.

Parameters:

method - - custom key method.

Method Detail

usingAddress

public static <T> ConcurrentPlayerMap<T> usingAddress()

Construct a new concurrent player map that uses each player's address as key.

Returns:

Concurrent player map.

usingName

public static <T> ConcurrentPlayerMap<T> usingName()

Construct a new concurrent player map that uses each player's name as key.

Returns:

Concurrent player map.

createValueMap

protected java.util.concurrent.ConcurrentMap<java.lang.Object,TValue> createValueMap()

Construct the map that will store the associated values.

The default implementation uses a ConcurrentHashMap.

Returns:

The value map.

createKeyCache

protected java.util.concurrent.ConcurrentMap<java.lang.Object,org.bukkit.entity.Player> createKeyCache()

Construct a cache of keys and the associated player.

Returns:

The key map.

findOnlinePlayer

protected org.bukkit.entity.Player findOnlinePlayer(java.lang.Object key)

Find an online player from the given key.

Parameters:

key - - a non-null key.

Returns:

The player with the given key, or NULL if not found.

lookupPlayer

protected org.bukkit.entity.Player lookupPlayer(java.lang.Object key)

Lookup a player by key in the cache, optionally searching every online player.

Parameters:

key - - the key of the player we are locating.

Returns:

The player, or NULL if not found.

Throws:

java.util.concurrent.ExecutionException

cachePlayerKey

protected java.lang.Object cachePlayerKey(org.bukkit.entity.Player player)

Retrieve the key of a particular player, ensuring it is cached.

Parameters:

player - - the player whose key we want to retrieve.

Returns:

The key.

put

public TValue put(org.bukkit.entity.Player key,
         TValue value)

Specified by:

put in interface java.util.Map<org.bukkit.entity.Player,TValue>

Overrides:

put in class java.util.AbstractMap<org.bukkit.entity.Player,TValue>

putIfAbsent

public TValue putIfAbsent(org.bukkit.entity.Player key,
                 TValue value)

Specified by:

putIfAbsent in interface java.util.concurrent.ConcurrentMap<org.bukkit.entity.Player,TValue>

replace

public TValue replace(org.bukkit.entity.Player key,
             TValue value)

Specified by:

replace in interface java.util.concurrent.ConcurrentMap<org.bukkit.entity.Player,TValue>

replace

public boolean replace(org.bukkit.entity.Player key,
              TValue oldValue,
              TValue newValue)

Specified by:

replace in interface java.util.concurrent.ConcurrentMap<org.bukkit.entity.Player,TValue>

remove

public TValue remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<org.bukkit.entity.Player,TValue>

Overrides:

remove in class java.util.AbstractMap<org.bukkit.entity.Player,TValue>

remove

public boolean remove(java.lang.Object key,
             java.lang.Object value)

Specified by:

remove in interface java.util.concurrent.ConcurrentMap<org.bukkit.entity.Player,TValue>

get

public TValue get(java.lang.Object key)

Specified by:

get in interface java.util.Map<org.bukkit.entity.Player,TValue>

Overrides:

get in class java.util.AbstractMap<org.bukkit.entity.Player,TValue>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<org.bukkit.entity.Player,TValue>

Overrides:

containsKey in class java.util.AbstractMap<org.bukkit.entity.Player,TValue>

entrySet

public java.util.Set<java.util.Map.Entry<org.bukkit.entity.Player,TValue>> entrySet()

Specified by:

entrySet in interface java.util.Map<org.bukkit.entity.Player,TValue>

Specified by:

entrySet in class java.util.AbstractMap<org.bukkit.entity.Player,TValue>