org.mini2Dx.core.collections.concurrent

Class ConcurrentArray<T>

java.lang.Object

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

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

All Implemented Interfaces:

java.lang.Iterable<T>, ConcurrentCollection

public class ConcurrentArray<T>
extends org.mini2Dx.gdx.utils.Array<T>
implements ConcurrentCollection

Nested Class Summary

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

org.mini2Dx.gdx.utils.Array.ArrayIterable<T>, org.mini2Dx.gdx.utils.Array.ArrayIterator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.mini2Dx.lockprovider.ReadWriteLock	lock

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

items, ordered, size

Constructor Summary

Constructors

Constructor and Description
ConcurrentArray() Creates an ordered array with a capacity of 16.
ConcurrentArray(org.mini2Dx.gdx.utils.Array<? extends T> array) Creates a new array containing the elements in the specified array.
ConcurrentArray(boolean ordered, int capacity)
ConcurrentArray(boolean ordered, int capacity, java.lang.Class arrayType) Creates a new array with Array.items of the specified type.
ConcurrentArray(boolean ordered, T[] array, int start, int count) Creates a new array containing the elements in the specified array.
ConcurrentArray(java.lang.Class arrayType) Creates an ordered array with Array.items of the specified type and a capacity of 16.
ConcurrentArray(int capacity) Creates an ordered array with the specified capacity.
ConcurrentArray(T[] array) Creates a new ordered array containing the elements in the specified array.

Method Summary

Modifier and Type	Method and Description
void	add(T value)
void	add(T value1, T value2)
void	add(T value1, T value2, T value3)
void	add(T value1, T value2, T value3, T value4)
void	addAll(org.mini2Dx.gdx.utils.Array<? extends T> array, int start, int count)
void	addAll(T[] array, int start, int count)
void	clear()
boolean	contains(T value, boolean identity) Returns true if this array contains the specified value.
boolean	containsAll(org.mini2Dx.gdx.utils.Array<? extends T> values, boolean identity) Returns true if this array contains all the specified values.
boolean	containsAny(org.mini2Dx.gdx.utils.Array<? extends T> values, boolean identity) Returns true if this array contains any the specified values.
T[]	ensureCapacity(int additionalCapacity) Increases the size of the backing array to accommodate the specified number of additional items.
boolean	equals(java.lang.Object object) Returns false if either array is unordered.
boolean	equalsIdentity(java.lang.Object object) Uses == for comparison of each item.
T	first() Returns the first item.
T	get(int index)
org.mini2Dx.lockprovider.ReadWriteLock	getLock() Returns the collection's ReadWriteLock
int	hashCode()
int	indexOf(T value, boolean identity) Returns the index of first occurrence of value in the array, or -1 if no such value exists.
void	insert(int index, T value)
boolean	isEmpty() Returns true if the array is empty.
org.mini2Dx.gdx.utils.Array.ArrayIterator<T>	iterator() Returns an iterator for the items in the array.
int	lastIndexOf(T value, boolean identity) Returns an index of last occurrence of value in array or -1 if no such value exists.
boolean	notEmpty() Returns true if the array has one or more items.
T	peek() Returns the last item.
T	pop() Removes and returns the last item.
T	random() Returns a random item from the array, or null if the array is empty.
boolean	removeAll(org.mini2Dx.gdx.utils.Array<? extends T> array, boolean identity) Removes from this array all of elements contained in the specified array.
T	removeIndex(int index) Removes and returns the item at the specified index.
void	removeRange(int start, int end) Removes the items between the specified indices, inclusive.
boolean	removeValue(T value, boolean identity) Removes the first instance of the specified value in the array.
void	reverse()
java.lang.Iterable<T>	select(org.mini2Dx.gdx.utils.Predicate<T> predicate) Returns an iterable for the selected items in the array.
T	selectRanked(java.util.Comparator<T> comparator, int kthLowest) Selects the nth-lowest element from the Array according to Comparator ranking.
int	selectRankedIndex(java.util.Comparator<T> comparator, int kthLowest)
void	set(int index, T value)
T[]	setSize(int newSize) Sets the array size, leaving any values beyond the current size null.
T[]	shrink() Reduces the size of the backing array to the size of the actual items.
void	shuffle()
int	size() Returns the size in a thread-safe manner
void	swap(int first, int second)
T[]	toArray() Returns the items as an array.
<V> V[]	toArray(java.lang.Class<V> type)
java.lang.String	toString()
java.lang.String	toString(java.lang.String separator)
void	truncate(int newSize) Reduces the size of the array to the specified size.

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

addAll, addAll, insertRange, of, of, resize, sort, sort, 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 org.mini2Dx.lockprovider.ReadWriteLock lock

Constructor Detail

ConcurrentArray

public ConcurrentArray()

Creates an ordered array with a capacity of 16.

ConcurrentArray

public ConcurrentArray(int capacity)

Creates an ordered array with the specified capacity.

Parameters:

capacity -

ConcurrentArray

public ConcurrentArray(boolean ordered,
                       int capacity)

Parameters:

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

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

ConcurrentArray

public ConcurrentArray(boolean ordered,
                       int capacity,
                       java.lang.Class arrayType)

Creates a new array with Array.items of the specified type.

Parameters:

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

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

arrayType -

ConcurrentArray

public ConcurrentArray(java.lang.Class arrayType)

Creates an ordered array with Array.items of the specified type and a capacity of 16.

Parameters:

arrayType -

ConcurrentArray

public ConcurrentArray(org.mini2Dx.gdx.utils.Array<? extends T> array)

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

Parameters:

array -

ConcurrentArray

public ConcurrentArray(T[] array)

Creates a new ordered array containing the elements in the specified array. The new array will have the same type of backing array. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.

Parameters:

array -

ConcurrentArray

public ConcurrentArray(boolean ordered,
                       T[] array,
                       int start,
                       int count)

Creates a new array containing the elements in the specified array. The new array will have the same type of backing array. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.

Parameters:

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

array -

start -

count -

Method Detail

size

public int size()

Returns the size in a thread-safe manner

Returns:

0 if empty

add

public void add(T value)

Overrides:

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

add

public void add(T value1,
                T value2)

Overrides:

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

add

public void add(T value1,
                T value2,
                T value3)

Overrides:

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

add

public void add(T value1,
                T value2,
                T value3,
                T value4)

Overrides:

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

addAll

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

Overrides:

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

addAll

public void addAll(T[] array,
                   int start,
                   int count)

Overrides:

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

get

public T get(int index)

Overrides:

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

set

public void set(int index,
                T value)

Overrides:

set in class org.mini2Dx.gdx.utils.Array<T>

insert

public void insert(int index,
                   T value)

Overrides:

insert in class org.mini2Dx.gdx.utils.Array<T>

swap

public void swap(int first,
                 int second)

Overrides:

swap in class org.mini2Dx.gdx.utils.Array<T>

contains

public boolean contains(T value,
                        boolean identity)

Returns true if this array contains the specified value.

Overrides:

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

Parameters:

value - May be null.

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

containsAll

public boolean containsAll(org.mini2Dx.gdx.utils.Array<? extends T> values,
                           boolean identity)

Returns true if this array contains all the specified values.

Overrides:

containsAll in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

values - May contains nulls.

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

containsAny

public boolean containsAny(org.mini2Dx.gdx.utils.Array<? extends T> values,
                           boolean identity)

Returns true if this array contains any the specified values.

Overrides:

containsAny in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

values - May contains nulls.

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

removeValue

public boolean removeValue(T value,
                           boolean identity)

Removes the first instance of the specified value in the array.

Overrides:

removeValue in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

value - May be null.

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

Returns:

true if value was found and removed, false otherwise

removeAll

public boolean removeAll(org.mini2Dx.gdx.utils.Array<? extends T> array,
                         boolean identity)

Removes from this array all of elements contained in the specified array.

Overrides:

removeAll in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

array -

identity - True to use ==, false to use .equals().

Returns:

true if this array was modified.

selectRanked

public T selectRanked(java.util.Comparator<T> comparator,
                      int kthLowest)

Selects the nth-lowest element from the Array according to Comparator ranking. This might partially sort the Array. The array must have a size greater than 0, or a GdxRuntimeException will be thrown.

Overrides:

selectRanked in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

comparator - used for comparison

kthLowest - rank of desired object according to comparison, n is based on ordinal numbers, not array indices. for min value use 1, for max value use size of array, using 0 results in runtime exception.

Returns:

the value of the Nth lowest ranked object.

See Also:

Select

selectRankedIndex

public int selectRankedIndex(java.util.Comparator<T> comparator,
                             int kthLowest)

Overrides:

selectRankedIndex in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

comparator - used for comparison

kthLowest - rank of desired object according to comparison, n is based on ordinal numbers, not array indices. for min value use 1, for max value use size of array, using 0 results in runtime exception.

Returns:

the index of the Nth lowest ranked object.

See Also:

Array.selectRanked(Comparator, int)

select

public java.lang.Iterable<T> select(org.mini2Dx.gdx.utils.Predicate<T> predicate)

Returns an iterable for the selected items in the array. Remove is supported, but not between hasNext() and next().

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

Overrides:

select in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

predicate -

indexOf

public int indexOf(T value,
                   boolean identity)

Returns the index of first occurrence of value in the array, or -1 if no such value exists.

Overrides:

indexOf in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

value - May be null.

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

Returns:

An index of first occurrence of value in array or -1 if no such value exists

lastIndexOf

public int lastIndexOf(T value,
                       boolean identity)

Returns an index of last occurrence of value in array or -1 if no such value exists. Search is started from the end of an array.

Overrides:

lastIndexOf in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

value - May be null.

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

Returns:

An index of last occurrence of value in array or -1 if no such value exists

removeIndex

public T removeIndex(int index)

Removes and returns the item at the specified index.

Overrides:

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

Parameters:

index -

removeRange

public void removeRange(int start,
                        int end)

Removes the items between the specified indices, inclusive.

Overrides:

removeRange in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

start -

end -

pop

public T pop()

Removes and returns the last item.

Overrides:

pop in class org.mini2Dx.gdx.utils.Array<T>

peek

public T peek()

Returns the last item.

Overrides:

peek in class org.mini2Dx.gdx.utils.Array<T>

first

public T first()

Returns the first item.

Overrides:

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

notEmpty

public boolean notEmpty()

Returns true if the array has one or more items.

Overrides:

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

isEmpty

public boolean isEmpty()

Returns true if the array is empty.

Overrides:

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

clear

public void clear()

Overrides:

clear in class org.mini2Dx.gdx.utils.Array<T>

iterator

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

Returns an iterator for the items in the array. Remove is supported.

Specified by:

iterator in interface java.lang.Iterable<T>

Overrides:

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

shrink

public T[] shrink()

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

Overrides:

shrink in class org.mini2Dx.gdx.utils.Array<T>

Returns:

Array.items

ensureCapacity

public T[] 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.Array<T>

Parameters:

additionalCapacity -

Returns:

Array.items

setSize

public T[] setSize(int newSize)

Sets the array size, leaving any values beyond the current size null.

Overrides:

setSize in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

newSize -

Returns:

Array.items

reverse

public void reverse()

Overrides:

reverse in class org.mini2Dx.gdx.utils.Array<T>

shuffle

public void shuffle()

Overrides:

shuffle in class org.mini2Dx.gdx.utils.Array<T>

truncate

public void truncate(int newSize)

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

Overrides:

truncate in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

newSize -

random

public T random()

Returns a random item from the array, or null if the array is empty.

Overrides:

random in class org.mini2Dx.gdx.utils.Array<T>

toArray

public T[] toArray()

Returns the items as an array. Note the array is typed, so the ConcurrentArray(Class) constructor must have been used. Otherwise use toArray(Class) to specify the array type.

Overrides:

toArray in class org.mini2Dx.gdx.utils.Array<T>

toArray

public <V> V[] toArray(java.lang.Class<V> type)

Overrides:

toArray in class org.mini2Dx.gdx.utils.Array<T>

hashCode

public int hashCode()

Overrides:

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

equals

public boolean equals(java.lang.Object object)

Returns false if either array is unordered.

Overrides:

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

Parameters:

object -

equalsIdentity

public boolean equalsIdentity(java.lang.Object object)

Uses == for comparison of each item. Returns false if either array is unordered.

Overrides:

equalsIdentity in class org.mini2Dx.gdx.utils.Array<T>

Parameters:

object -

toString

public java.lang.String toString()

Overrides:

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

toString

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

Overrides:

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

getLock

public org.mini2Dx.lockprovider.ReadWriteLock getLock()

Description copied from interface: ConcurrentCollection

Returns the collection's ReadWriteLock

Specified by:

getLock in interface ConcurrentCollection

Returns:

the collection's ReadWriteLock