org.mini2Dx.core.collections.concurrent

Class ConcurrentOrderedMap<K,V>

java.lang.Object

org.mini2Dx.gdx.utils.ObjectMap<K,V>

org.mini2Dx.gdx.utils.OrderedMap<K,V>

org.mini2Dx.core.collections.concurrent.ConcurrentOrderedMap<K,V>

All Implemented Interfaces:

java.lang.Iterable<org.mini2Dx.gdx.utils.ObjectMap.Entry<K,V>>, ConcurrentCollection

public class ConcurrentOrderedMap<K,V>
extends org.mini2Dx.gdx.utils.OrderedMap<K,V>
implements ConcurrentCollection

Nested Class Summary

Nested classes/interfaces inherited from class org.mini2Dx.gdx.utils.OrderedMap

org.mini2Dx.gdx.utils.OrderedMap.OrderedMapEntries<K,V>, org.mini2Dx.gdx.utils.OrderedMap.OrderedMapKeys<K>, org.mini2Dx.gdx.utils.OrderedMap.OrderedMapValues<V>

Nested classes/interfaces inherited from class org.mini2Dx.gdx.utils.ObjectMap

org.mini2Dx.gdx.utils.ObjectMap.Entries<K,V>, org.mini2Dx.gdx.utils.ObjectMap.Entry<K,V>, org.mini2Dx.gdx.utils.ObjectMap.Keys<K>, org.mini2Dx.gdx.utils.ObjectMap.Values<V>

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadWriteLock	lock

Fields inherited from class org.mini2Dx.gdx.utils.ObjectMap

size

Constructor Summary

Constructors

Constructor and Description
ConcurrentOrderedMap() Creates a new map with an initial capacity of 51 and a load factor of 0.8.
ConcurrentOrderedMap(int initialCapacity) Creates a new map with a load factor of 0.8.
ConcurrentOrderedMap(int initialCapacity, float loadFactor) Creates a new map with the specified initial capacity and load factor.
ConcurrentOrderedMap(org.mini2Dx.gdx.utils.OrderedMap<? extends K,? extends V> map) Creates a new map identical to the specified map.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the map, leaving the backing arrays at the current capacity.
void	clear(int maximumCapacity) Clears the map and reduces the size of the backing arrays to be the specified capacity, if they are larger.
boolean	containsKey(K key)
boolean	containsValue(java.lang.Object value, boolean identity) Returns true if the specified value is in the map.
void	ensureCapacity(int additionalCapacity) Increases the size of the backing array to accommodate the specified number of additional items.
org.mini2Dx.gdx.utils.ObjectMap.Entries<K,V>	entries() Returns an iterator for the entries in the map.
boolean	equals(java.lang.Object obj)
boolean	equalsIdentity(java.lang.Object obj) Uses == for comparison of each value.
K	findKey(java.lang.Object value, boolean identity) Returns the key for the specified value, or null if it is not in the map.
V	get(K key) Returns the value (which may be null) for the specified key, or null if the key is not in the map.
V	get(K key, V defaultValue) Returns the value (which may be null) for the specified key, or the default value if the key is not in the map.
ReadWriteLock	getLock() Returns the collection's ReadWriteLock
int	hashCode()
boolean	isEmpty() Returns true if the map is empty.
org.mini2Dx.gdx.utils.ObjectMap.Keys<K>	keys() Returns an iterator for the keys in the map.
boolean	notEmpty() Returns true if the map has one or more items.
org.mini2Dx.gdx.utils.Array<K>	orderedKeys()
V	put(K key, V value) Returns the old value associated with the specified key, or null.
void	putAll(org.mini2Dx.gdx.utils.ObjectMap<? extends K,? extends V> map)
V	remove(K key) Returns the value associated with the key, or null.
V	removeIndex(int index)
void	shrink(int maximumCapacity) Reduces the size of the backing arrays to be the specified capacity or less.
java.lang.String	toString()
java.lang.String	toString(java.lang.String separator)
org.mini2Dx.gdx.utils.ObjectMap.Values<V>	values() Returns an iterator for the values in the map.

Methods inherited from class org.mini2Dx.gdx.utils.OrderedMap

iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

lock

protected ReadWriteLock lock

Constructor Detail

ConcurrentOrderedMap

public ConcurrentOrderedMap()

Creates a new map with an initial capacity of 51 and a load factor of 0.8.

ConcurrentOrderedMap

public ConcurrentOrderedMap(int initialCapacity)

Creates a new map with a load factor of 0.8.

Parameters:

initialCapacity - If not a power of two, it is increased to the next nearest power of two.

ConcurrentOrderedMap

public ConcurrentOrderedMap(int initialCapacity,
                            float loadFactor)

Creates a new map with the specified initial capacity and load factor. This map will hold initialCapacity items before growing the backing table.

Parameters:

initialCapacity - If not a power of two, it is increased to the next nearest power of two.

loadFactor -

ConcurrentOrderedMap

public ConcurrentOrderedMap(org.mini2Dx.gdx.utils.OrderedMap<? extends K,? extends V> map)

Creates a new map identical to the specified map. NOTE: read access to the other map is not thread-safe

Parameters:

map -

Method Detail

put

public V put(K key,
             V value)

Returns the old value associated with the specified key, or null.

Overrides:

put in class org.mini2Dx.gdx.utils.OrderedMap<K,V>

Parameters:

key -

value -

putAll

public void putAll(org.mini2Dx.gdx.utils.ObjectMap<? extends K,? extends V> map)

Overrides:

putAll in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

get

public V get(K key)

Returns the value (which may be null) for the specified key, or null if the key is not in the map.

Overrides:

get in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

Parameters:

key -

get

public V get(K key,
             V defaultValue)

Returns the value (which may be null) for the specified key, or the default value if the key is not in the map.

Overrides:

get in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

Parameters:

key -

defaultValue -

remove

public V remove(K key)

Returns the value associated with the key, or null.

Overrides:

remove in class org.mini2Dx.gdx.utils.OrderedMap<K,V>

Parameters:

key -

notEmpty

public boolean notEmpty()

Returns true if the map has one or more items.

Overrides:

notEmpty in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

isEmpty

public boolean isEmpty()

Returns true if the map is empty.

Overrides:

isEmpty in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

shrink

public void shrink(int maximumCapacity)

Reduces the size of the backing arrays to be the specified capacity or less. If the capacity is already less, nothing is done. If the map contains more items than the specified capacity, the next highest power of two capacity is used instead.

Overrides:

shrink in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

Parameters:

maximumCapacity -

clear

public void clear(int maximumCapacity)

Clears the map and reduces the size of the backing arrays to be the specified capacity, if they are larger. The reduction is done by allocating new arrays, though for large arrays this can be faster than clearing the existing array.

Overrides:

clear in class org.mini2Dx.gdx.utils.OrderedMap<K,V>

Parameters:

maximumCapacity -

clear

public void clear()

Clears the map, leaving the backing arrays at the current capacity. When the capacity is high and the population is low, iteration can be unnecessarily slow. clear(int) can be used to reduce the capacity.

Overrides:

clear in class org.mini2Dx.gdx.utils.OrderedMap<K,V>

containsValue

public boolean containsValue(java.lang.Object value,
                             boolean identity)

Returns true if the specified value is in the map. Note this traverses the entire map and compares every value, which may be an expensive operation.

Overrides:

containsValue in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

Parameters:

value -

identity - If true, uses == to compare the specified value with values in the map. If false, uses equals(Object).

containsKey

public boolean containsKey(K key)

Overrides:

containsKey in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

findKey

public K findKey(java.lang.Object value,
                 boolean identity)

Returns the key for the specified value, or null if it is not in the map. Note this traverses the entire map and compares every value, which may be an expensive operation.

Overrides:

findKey in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

Parameters:

value -

identity - If true, uses == to compare the specified value with values in the map. If false, uses equals(Object).

ensureCapacity

public void ensureCapacity(int additionalCapacity)

Increases the size of the backing array to accommodate the specified number of additional items. Useful before adding many items to avoid multiple backing array resizes.

Overrides:

ensureCapacity in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

Parameters:

additionalCapacity -

removeIndex

public V removeIndex(int index)

Overrides:

removeIndex in class org.mini2Dx.gdx.utils.OrderedMap<K,V>

orderedKeys

public org.mini2Dx.gdx.utils.Array<K> orderedKeys()

Overrides:

orderedKeys in class org.mini2Dx.gdx.utils.OrderedMap<K,V>

keys

public org.mini2Dx.gdx.utils.ObjectMap.Keys<K> keys()

Returns an iterator for the keys in the map. Remove is supported.

If Collections.allocateIterators is false, the same iterator instance is returned each time this method is called. Use the OrderedMapKeys constructor for nested or multithreaded iteration.

Overrides:

keys in class org.mini2Dx.gdx.utils.OrderedMap<K,V>

hashCode

public int hashCode()

Overrides:

hashCode in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

equalsIdentity

public boolean equalsIdentity(java.lang.Object obj)

Uses == for comparison of each value.

Overrides:

equalsIdentity in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

Parameters:

obj -

toString

public java.lang.String toString(java.lang.String separator)

Overrides:

toString in class org.mini2Dx.gdx.utils.ObjectMap<K,V>

toString

public java.lang.String toString()

Overrides:

toString in class org.mini2Dx.gdx.utils.OrderedMap<K,V>

entries

public org.mini2Dx.gdx.utils.ObjectMap.Entries<K,V> entries()

Returns an iterator for the entries in the map. Remove is supported.

Overrides:

entries in class org.mini2Dx.gdx.utils.OrderedMap<K,V>

values

public org.mini2Dx.gdx.utils.ObjectMap.Values<V> values()

Returns an iterator for the values in the map. Remove is supported.

Overrides:

values in class org.mini2Dx.gdx.utils.OrderedMap<K,V>

getLock

public ReadWriteLock getLock()

Description copied from interface: ConcurrentCollection

Returns the collection's ReadWriteLock

Specified by:

getLock in interface ConcurrentCollection

Returns:

the collection's ReadWriteLock