org.mini2Dx.core.collections.concurrent

Class ConcurrentOrderedSet<T>

java.lang.Object

org.mini2Dx.gdx.utils.ObjectSet<T>

org.mini2Dx.gdx.utils.OrderedSet<T>

org.mini2Dx.core.collections.concurrent.ConcurrentOrderedSet<T>

All Implemented Interfaces:

java.lang.Iterable<T>, ConcurrentCollection

public class ConcurrentOrderedSet<T>
extends org.mini2Dx.gdx.utils.OrderedSet<T>
implements ConcurrentCollection

Nested Class Summary

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

org.mini2Dx.gdx.utils.OrderedSet.OrderedSetIterator<T>

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

org.mini2Dx.gdx.utils.ObjectSet.ObjectSetIterator<K>

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadWriteLock	lock

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

size

Constructor Summary

Constructors

Constructor and Description
ConcurrentOrderedSet() Creates a new set with an initial capacity of 51 and a load factor of 0.8.
ConcurrentOrderedSet(int initialCapacity) Creates a new set with a load factor of 0.8.
ConcurrentOrderedSet(int initialCapacity, float loadFactor) Creates a new set with the specified initial capacity and load factor.
ConcurrentOrderedSet(org.mini2Dx.gdx.utils.OrderedSet<? extends T> set) Creates a new set identical to the specified set.

Method Summary

Modifier and Type	Method and Description
boolean	add(T key) Returns true if the key was not already in the set.
boolean	add(T key, int index)
void	addAll(org.mini2Dx.gdx.utils.Array<? extends T> array, int offset, int length)
void	addAll(org.mini2Dx.gdx.utils.ObjectSet<T> set)
void	addAll(T[] array, int offset, int length)
void	clear() Clears the set, leaving the backing arrays at the current capacity.
void	clear(int maximumCapacity) Clears the set and reduces the size of the backing arrays to be the specified capacity, if they are larger.
boolean	contains(T key)
void	ensureCapacity(int additionalCapacity) Increases the size of the backing array to accommodate the specified number of additional items.
boolean	equals(java.lang.Object obj)
T	first()
T	get(T key)
ReadWriteLock	getLock() Returns the collection's ReadWriteLock
int	hashCode()
boolean	isEmpty() Returns true if the set is empty.
org.mini2Dx.gdx.utils.OrderedSet.OrderedSetIterator<T>	iterator() Returns an iterator for the keys in the set.
boolean	notEmpty() Returns true if the set has one or more items.
org.mini2Dx.gdx.utils.Array<T>	orderedItems()
boolean	remove(T key) Returns true if the key was removed.
T	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)

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

addAll, addAll, with

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

ConcurrentOrderedSet

public ConcurrentOrderedSet()

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

ConcurrentOrderedSet

public ConcurrentOrderedSet(int initialCapacity)

Creates a new set 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.

ConcurrentOrderedSet

public ConcurrentOrderedSet(int initialCapacity,
                            float loadFactor)

Creates a new set with the specified initial capacity and load factor. This set 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 -

ConcurrentOrderedSet

public ConcurrentOrderedSet(org.mini2Dx.gdx.utils.OrderedSet<? extends T> set)

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

Parameters:

set -

Method Detail

add

public boolean add(T key)

Returns true if the key was not already in the set. If this set already contains the key, the call leaves the set unchanged and returns false.

Overrides:

add in class org.mini2Dx.gdx.utils.OrderedSet<T>

Parameters:

key -

addAll

public void addAll(org.mini2Dx.gdx.utils.Array<? extends T> array,
                   int offset,
                   int length)

Overrides:

addAll in class org.mini2Dx.gdx.utils.ObjectSet<T>

addAll

public void addAll(T[] array,
                   int offset,
                   int length)

Overrides:

addAll in class org.mini2Dx.gdx.utils.ObjectSet<T>

addAll

public void addAll(org.mini2Dx.gdx.utils.ObjectSet<T> set)

Overrides:

addAll in class org.mini2Dx.gdx.utils.ObjectSet<T>

remove

public boolean remove(T key)

Returns true if the key was removed.

Overrides:

remove in class org.mini2Dx.gdx.utils.OrderedSet<T>

Parameters:

key -

notEmpty

public boolean notEmpty()

Returns true if the set has one or more items.

Overrides:

notEmpty in class org.mini2Dx.gdx.utils.ObjectSet<T>

isEmpty

public boolean isEmpty()

Returns true if the set is empty.

Overrides:

isEmpty in class org.mini2Dx.gdx.utils.ObjectSet<T>

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 set 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.ObjectSet<T>

Parameters:

maximumCapacity -

clear

public void clear(int maximumCapacity)

Clears the set 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.OrderedSet<T>

Parameters:

maximumCapacity -

clear

public void clear()

Clears the set, 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.OrderedSet<T>

contains

public boolean contains(T key)

Overrides:

contains in class org.mini2Dx.gdx.utils.ObjectSet<T>

get

public T get(T key)

Overrides:

get in class org.mini2Dx.gdx.utils.ObjectSet<T>

Parameters:

key -

Returns:

May be null.

first

public T first()

Overrides:

first in class org.mini2Dx.gdx.utils.ObjectSet<T>

add

public boolean add(T key,
                   int index)

Overrides:

add in class org.mini2Dx.gdx.utils.OrderedSet<T>

removeIndex

public T removeIndex(int index)

Overrides:

removeIndex in class org.mini2Dx.gdx.utils.OrderedSet<T>

orderedItems

public org.mini2Dx.gdx.utils.Array<T> orderedItems()

Overrides:

orderedItems in class org.mini2Dx.gdx.utils.OrderedSet<T>

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.ObjectSet<T>

Parameters:

additionalCapacity -

hashCode

public int hashCode()

Overrides:

hashCode in class org.mini2Dx.gdx.utils.ObjectSet<T>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class org.mini2Dx.gdx.utils.ObjectSet<T>

toString

public java.lang.String toString()

Overrides:

toString in class org.mini2Dx.gdx.utils.OrderedSet<T>

toString

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

Overrides:

toString in class org.mini2Dx.gdx.utils.OrderedSet<T>

iterator

public org.mini2Dx.gdx.utils.OrderedSet.OrderedSetIterator<T> iterator()

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

Specified by:

iterator in interface java.lang.Iterable<T>

Overrides:

iterator in class org.mini2Dx.gdx.utils.OrderedSet<T>

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