org.mini2Dx.core.collections.concurrent

Class ConcurrentArrayMap<K,V>

java.lang.Object

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

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

All Implemented Interfaces:

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

public class ConcurrentArrayMap<K,V>
extends org.mini2Dx.gdx.utils.ArrayMap<K,V>
implements ConcurrentCollection

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadWriteLock	lock

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

keys, ordered, size, values

Constructor Summary

Constructors

Constructor and Description
ConcurrentArrayMap() Creates an ordered map with a capacity of 16.
ConcurrentArrayMap(org.mini2Dx.gdx.utils.ArrayMap array) Creates a new map containing the elements in the specified map.
ConcurrentArrayMap(boolean ordered, int capacity)
ConcurrentArrayMap(boolean ordered, int capacity, java.lang.Class keyArrayType, java.lang.Class valueArrayType) Creates a new map with keys() and values() of the specified type.
ConcurrentArrayMap(java.lang.Class keyArrayType, java.lang.Class valueArrayType) Creates an ordered map with keys() and values() of the specified type and a capacity of 16.
ConcurrentArrayMap(int capacity) Creates an ordered map with the specified capacity.

Method Summary

Modifier and Type	Method and Description
void	clear()
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(V value, boolean identity)
void	ensureCapacity(int additionalCapacity) Increases the size of the backing arrays to accommodate the specified number of additional entries.
org.mini2Dx.gdx.utils.ArrayMap.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	firstKey()
V	firstValue()
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.
K	getKey(V value, boolean identity) Returns the key for the specified value.
K	getKeyAt(int index)
ReadWriteLock	getLock() Returns the collection's ReadWriteLock
V	getValueAt(int index)
int	hashCode()
int	indexOfKey(K key)
int	indexOfValue(V value, boolean identity)
void	insert(int index, K key, V value)
boolean	isEmpty() Returns true if the map is empty.
org.mini2Dx.gdx.utils.ArrayMap.Keys<K>	keys() Returns an iterator for the keys in the map.
boolean	notEmpty() Returns true if the map has one or more items.
K	peekKey() Returns the last key.
V	peekValue() Returns the last value.
int	put(K key, V value)
int	put(K key, V value, int index)
void	putAll(org.mini2Dx.gdx.utils.ArrayMap<? extends K,? extends V> map, int offset, int length)
void	removeIndex(int index) Removes and returns the key/values pair at the specified index.
V	removeKey(K key)
boolean	removeValue(V value, boolean identity)
void	reverse()
void	setKey(int index, K key)
void	setValue(int index, V value)
void	shrink() Reduces the size of the backing arrays to the size of the actual number of entries.
void	shuffle()
java.lang.String	toString()
void	truncate(int newSize) Reduces the size of the arrays to the specified size.
org.mini2Dx.gdx.utils.ArrayMap.Values<V>	values() Returns an iterator for the values in the map.

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

iterator, putAll, resize

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

ConcurrentArrayMap

public ConcurrentArrayMap()

Creates an ordered map with a capacity of 16.

ConcurrentArrayMap

public ConcurrentArrayMap(int capacity)

Creates an ordered map with the specified capacity.

Parameters:

capacity -

ConcurrentArrayMap

public ConcurrentArrayMap(boolean ordered,
                          int capacity)

Parameters:

ordered - If false, methods that remove elements may change the order of other elements in the arrays, which avoids a memory copy.

capacity - Any elements added beyond this will cause the backing arrays to be grown.

ConcurrentArrayMap

public ConcurrentArrayMap(boolean ordered,
                          int capacity,
                          java.lang.Class keyArrayType,
                          java.lang.Class valueArrayType)

Creates a new map with keys() and values() of the specified type.

Parameters:

ordered - If false, methods that remove elements may change the order of other elements in the arrays, which avoids a memory copy.

capacity - Any elements added beyond this will cause the backing arrays to be grown.

keyArrayType -

valueArrayType -

ConcurrentArrayMap

public ConcurrentArrayMap(java.lang.Class keyArrayType,
                          java.lang.Class valueArrayType)

Creates an ordered map with keys() and values() of the specified type and a capacity of 16.

Parameters:

keyArrayType -

valueArrayType -

ConcurrentArrayMap

public ConcurrentArrayMap(org.mini2Dx.gdx.utils.ArrayMap array)

Creates a new map containing the elements in the specified map. The new map will have the same type of backing arrays and will be ordered if the specified map is ordered. The capacity is set to the number of elements, so any subsequent elements added will cause the backing arrays to be grown. NOTE: read access to the other ArrayMap is not thread-safe

Parameters:

array -

Method Detail

put

public int put(K key,
               V value)

Overrides:

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

put

public int put(K key,
               V value,
               int index)

Overrides:

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

putAll

public void putAll(org.mini2Dx.gdx.utils.ArrayMap<? extends K,? extends V> map,
                   int offset,
                   int length)

Overrides:

putAll in class org.mini2Dx.gdx.utils.ArrayMap<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. Note this does a .equals() comparison of each key in reverse order until the specified key is found.

Overrides:

get in class org.mini2Dx.gdx.utils.ArrayMap<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. Note this does a .equals() comparison of each key in reverse order until the specified key is found.

Overrides:

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

Parameters:

key -

defaultValue -

getKey

public K getKey(V value,
                boolean identity)

Returns the key for the specified value. Note this does a comparison of each value in reverse order until the specified value is found.

Overrides:

getKey in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

Parameters:

value -

identity - If true, == comparison will be used. If false, .equals() comparison will be used.

getKeyAt

public K getKeyAt(int index)

Overrides:

getKeyAt in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

getValueAt

public V getValueAt(int index)

Overrides:

getValueAt in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

firstKey

public K firstKey()

Overrides:

firstKey in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

firstValue

public V firstValue()

Overrides:

firstValue in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

setKey

public void setKey(int index,
                   K key)

Overrides:

setKey in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

setValue

public void setValue(int index,
                     V value)

Overrides:

setValue in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

insert

public void insert(int index,
                   K key,
                   V value)

Overrides:

insert in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

containsKey

public boolean containsKey(K key)

Overrides:

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

containsValue

public boolean containsValue(V value,
                             boolean identity)

Overrides:

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

Parameters:

value -

identity - If true, == comparison will be used. If false, .equals() comparison will be used.

indexOfKey

public int indexOfKey(K key)

Overrides:

indexOfKey in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

indexOfValue

public int indexOfValue(V value,
                        boolean identity)

Overrides:

indexOfValue in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

removeIndex

public void removeIndex(int index)

Removes and returns the key/values pair at the specified index.

Overrides:

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

Parameters:

index -

notEmpty

public boolean notEmpty()

Returns true if the map has one or more items.

Overrides:

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

isEmpty

public boolean isEmpty()

Returns true if the map is empty.

Overrides:

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

peekKey

public K peekKey()

Returns the last key.

Overrides:

peekKey in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

peekValue

public V peekValue()

Returns the last value.

Overrides:

peekValue in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

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.

Overrides:

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

Parameters:

maximumCapacity -

clear

public void clear()

Overrides:

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

shrink

public void shrink()

Reduces the size of the backing arrays to the size of the actual number of entries. This is useful to release memory when many items have been removed, or if it is known that more entries will not be added.

Overrides:

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

ensureCapacity

public void ensureCapacity(int additionalCapacity)

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

Overrides:

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

Parameters:

additionalCapacity -

reverse

public void reverse()

Overrides:

reverse in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

shuffle

public void shuffle()

Overrides:

shuffle in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

truncate

public void truncate(int newSize)

Reduces the size of the arrays to the specified size. If the arrays are already smaller than the specified size, no action is taken.

Overrides:

truncate in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

Parameters:

newSize -

removeKey

public V removeKey(K key)

Overrides:

removeKey in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

removeValue

public boolean removeValue(V value,
                           boolean identity)

Overrides:

removeValue in class org.mini2Dx.gdx.utils.ArrayMap<K,V>

hashCode

public int hashCode()

Overrides:

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

equals

public boolean equals(java.lang.Object obj)

Overrides:

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

equalsIdentity

public boolean equalsIdentity(java.lang.Object obj)

Uses == for comparison of each value.

Overrides:

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

Parameters:

obj -

toString

public java.lang.String toString()

Overrides:

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

entries

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

Returns an iterator for the entries 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 Entries constructor for nested or multithreaded iteration.

Overrides:

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

See Also:

Collections.allocateIterators

values

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

Returns an iterator for the values 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 Entries constructor for nested or multithreaded iteration.

Overrides:

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

See Also:

Collections.allocateIterators

keys

public org.mini2Dx.gdx.utils.ArrayMap.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 Entries constructor for nested or multithreaded iteration.

Overrides:

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

See Also:

Collections.allocateIterators

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