libGDX 1.14.2 · com.badlogic.gdx.utils.SnapshotArray

An array that allows modification during iteration. Guarantees that array entries provided by begin() between indexes 0 and size at the time begin was called will not be modified until end() is called. If modification of the SnapshotArray occurs between begin/end, the backing array is copied prior to the modification, ensuring that the backing array that was returned by begin() is unaffected. To avoid allocation, an attempt is made to reuse any extra array created as a result of this copy on subsequent copies.

Note that SnapshotArray is not for thread safety, only for modification during iteration.

It is suggested iteration be done in this specific way:

SnapshotArray array = new SnapshotArray();
// ...
Object[] items = array.begin();
for (int i = 0, n = array.size; i < n; i++) {
	Item item = (Item)items[i];
	// ...
}
array.end();

Field Summary

Modifier and Type	Field and Description
private T[]	recycled
private T[]	snapshot
private int	snapshots

Inherited from com.badlogic.gdx.utils.Array:: items ordered size

Constructor Summary

Access	Constructor and Description
public	SnapshotArray()
public	SnapshotArray(Array<T> array)
public	SnapshotArray(boolean ordered, int capacity, ArraySupplier<T[]> arraySupplier)
public	SnapshotArray(boolean ordered, int capacity, Class<T> arrayType) Deprecated
public	SnapshotArray(boolean ordered, int capacity)
public	SnapshotArray(boolean ordered, T[] array, int startIndex, int count)
public	SnapshotArray(ArraySupplier<T[]> arraySupplier)
public	SnapshotArray(Class<T> arrayType) Deprecated
public	SnapshotArray(int capacity)
public	SnapshotArray(T[] array)

Method Summary

Modifier and Type	Method and Description
public T[]	begin() Returns the backing array, which is guaranteed to not be modified before `end()`.
public void	clear() Overrides com.badlogic.gdx.utils.Array.clear.
public void	end() Releases the guarantee that the array returned by `begin()` won't be modified.
public void	insert(int index, T value) Overrides com.badlogic.gdx.utils.Array.insert.
public void	insertRange(int index, int count) Overrides com.badlogic.gdx.utils.Array.insertRange. Inserts the specified number of items at the specified index.
private void	modified()
public T	pop() Overrides com.badlogic.gdx.utils.Array.pop. Removes and returns the last item.
public boolean	removeAll(Array<? extends T> array, boolean identity) Overrides com.badlogic.gdx.utils.Array.removeAll. Removes from this array the first instance of each element contained in the specified array.
public T	removeIndex(int index) Overrides com.badlogic.gdx.utils.Array.removeIndex. Removes and returns the item at the specified index.
public void	removeRange(int start, int end) Overrides com.badlogic.gdx.utils.Array.removeRange. Removes the items between the specified indices, inclusive.
public boolean	removeValue(T value, boolean identity) Overrides com.badlogic.gdx.utils.Array.removeValue. Removes the first instance of the specified value in the array.
public int	replaceAll(T value, boolean identity, T replacement) Overrides com.badlogic.gdx.utils.Array.replaceAll. Returns the number of replacements done.
public boolean	replaceFirst(T value, boolean identity, T replacement) Overrides com.badlogic.gdx.utils.Array.replaceFirst. Returns true if the specified value was replaced successfully with the replacement
public void	reverse() Overrides com.badlogic.gdx.utils.Array.reverse.
public void	set(int index, T value) Overrides com.badlogic.gdx.utils.Array.set.
public T[]	setSize(int newSize) Overrides com.badlogic.gdx.utils.Array.setSize. Sets the array size, leaving any values beyond the current size null.
public void	shuffle() Overrides com.badlogic.gdx.utils.Array.shuffle.
public void	sort() Overrides com.badlogic.gdx.utils.Array.sort. Sorts this array.
public void	sort(Comparator<? super T> comparator) Overrides com.badlogic.gdx.utils.Array.sort. Sorts the array.
public void	swap(int first, int second) Overrides com.badlogic.gdx.utils.Array.swap.
public void	truncate(int newSize) Overrides com.badlogic.gdx.utils.Array.truncate. Reduces the size of the array to the specified size.
public static <T> SnapshotArray<T>	with(T... array) Hides com.badlogic.gdx.utils.Array.with.

Field Detail

recycled	back to summary
private T[] recycled

snapshot	back to summary
private T[] snapshot

snapshots	back to summary
private int snapshots

Constructor Detail

SnapshotArray	back to summary
public SnapshotArray()

SnapshotArray	back to summary
public SnapshotArray(Array<T> array)

SnapshotArray	back to summary
public SnapshotArray(boolean ordered, int capacity, ArraySupplier<T[]> arraySupplier)

SnapshotArray	back to summary
public SnapshotArray(boolean ordered, int capacity, Class<T> arrayType) Deprecated Annotations @Deprecated

SnapshotArray	back to summary
public SnapshotArray(boolean ordered, int capacity)

SnapshotArray	back to summary
public SnapshotArray(boolean ordered, T[] array, int startIndex, int count)

SnapshotArray	back to summary
public SnapshotArray(ArraySupplier<T[]> arraySupplier)

SnapshotArray	back to summary
public SnapshotArray(Class<T> arrayType) Deprecated Annotations @Deprecated

SnapshotArray	back to summary
public SnapshotArray(int capacity)

SnapshotArray	back to summary
public SnapshotArray(T[] array)

Method Detail

begin	back to summary
public T[] begin() Returns the backing array, which is guaranteed to not be modified before `end()`.

clear	back to summary
public void clear() Overrides com.badlogic.gdx.utils.Array.clear.

end	back to summary
public void end() Releases the guarantee that the array returned by `begin()` won't be modified.

insert	back to summary
public void insert(int index, T value) Overrides com.badlogic.gdx.utils.Array.insert.

insertRange	back to summary
public void insertRange(int index, int count) Overrides com.badlogic.gdx.utils.Array.insertRange. Doc from com.badlogic.gdx.utils.Array.insertRange. Inserts the specified number of items at the specified index. The new items will have values equal to the values at those indices before the insertion.

insertRange

back to summary

public void insertRange(int index, int count)

Overrides com.badlogic.gdx.utils.Array.insertRange.

Doc from com.badlogic.gdx.utils.Array.insertRange.

Inserts the specified number of items at the specified index. The new items will have values equal to the values at those indices before the insertion.

modified	back to summary
private void modified()

pop	back to summary
public T pop() Overrides com.badlogic.gdx.utils.Array.pop. Doc from com.badlogic.gdx.utils.Array.pop. Removes and returns the last item.

pop

back to summary

public T pop()

Overrides com.badlogic.gdx.utils.Array.pop.

Doc from com.badlogic.gdx.utils.Array.pop.

Removes and returns the last item.

removeAll	back to summary
public boolean removeAll(Array<? extends T> array, boolean identity) Overrides com.badlogic.gdx.utils.Array.removeAll. Doc from com.badlogic.gdx.utils.Array.removeAll. Removes from this array the first instance of each element contained in the specified array.

removeAll

back to summary

public boolean removeAll(Array<? extends T> array, boolean identity)

Overrides com.badlogic.gdx.utils.Array.removeAll.

Doc from com.badlogic.gdx.utils.Array.removeAll.

Removes from this array the first instance of each element contained in the specified array.

removeIndex	back to summary
public T removeIndex(int index) Overrides com.badlogic.gdx.utils.Array.removeIndex. Doc from com.badlogic.gdx.utils.Array.removeIndex. Removes and returns the item at the specified index.

removeIndex

back to summary

public T removeIndex(int index)

Overrides com.badlogic.gdx.utils.Array.removeIndex.

Doc from com.badlogic.gdx.utils.Array.removeIndex.

Removes and returns the item at the specified index.

removeRange	back to summary
public void removeRange(int start, int end) Overrides com.badlogic.gdx.utils.Array.removeRange. Doc from com.badlogic.gdx.utils.Array.removeRange. Removes the items between the specified indices, inclusive.

removeRange

back to summary

public void removeRange(int start, int end)

Overrides com.badlogic.gdx.utils.Array.removeRange.

Doc from com.badlogic.gdx.utils.Array.removeRange.

Removes the items between the specified indices, inclusive.

removeValue	back to summary
public boolean removeValue(T value, boolean identity) Overrides com.badlogic.gdx.utils.Array.removeValue. Doc from com.badlogic.gdx.utils.Array.removeValue. Removes the first instance of the specified value in the array.

removeValue

back to summary

public boolean removeValue(T value, boolean identity)

Overrides com.badlogic.gdx.utils.Array.removeValue.

Doc from com.badlogic.gdx.utils.Array.removeValue.

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

replaceAll	back to summary
public int replaceAll(T value, boolean identity, T replacement) Overrides com.badlogic.gdx.utils.Array.replaceAll. Doc from com.badlogic.gdx.utils.Array.replaceAll. Returns the number of replacements done.

replaceAll

back to summary

public int replaceAll(T value, boolean identity, T replacement)

Overrides com.badlogic.gdx.utils.Array.replaceAll.

Doc from com.badlogic.gdx.utils.Array.replaceAll.

Returns the number of replacements done.

replaceFirst	back to summary
public boolean replaceFirst(T value, boolean identity, T replacement) Overrides com.badlogic.gdx.utils.Array.replaceFirst. Doc from com.badlogic.gdx.utils.Array.replaceFirst. Returns true if the specified value was replaced successfully with the replacement

replaceFirst

back to summary

public boolean replaceFirst(T value, boolean identity, T replacement)

Overrides com.badlogic.gdx.utils.Array.replaceFirst.

Doc from com.badlogic.gdx.utils.Array.replaceFirst.

Returns true if the specified value was replaced successfully with the replacement

reverse	back to summary
public void reverse() Overrides com.badlogic.gdx.utils.Array.reverse.

set	back to summary
public void set(int index, T value) Overrides com.badlogic.gdx.utils.Array.set.

setSize	back to summary
public T[] setSize(int newSize) Overrides com.badlogic.gdx.utils.Array.setSize. Doc from com.badlogic.gdx.utils.Array.setSize. Sets the array size, leaving any values beyond the current size null.

setSize

back to summary

public T[] setSize(int newSize)

Overrides com.badlogic.gdx.utils.Array.setSize.

Doc from com.badlogic.gdx.utils.Array.setSize.

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

shuffle	back to summary
public void shuffle() Overrides com.badlogic.gdx.utils.Array.shuffle.

sort back to summary

sort	back to summary
public void sort() Overrides com.badlogic.gdx.utils.Array.sort. Doc from com.badlogic.gdx.utils.Array.sort. Sorts this array. The array elements must implement `Comparable`. This method is not thread safe (uses `Sort#instance()`).

public void sort()

Overrides com.badlogic.gdx.utils.Array.sort.

Doc from com.badlogic.gdx.utils.Array.sort.

Sorts this array. The array elements must implement Comparable. This method is not thread safe (uses Sort#instance()).

sort back to summary

sort	back to summary
public void sort(Comparator<? super T> comparator) Overrides com.badlogic.gdx.utils.Array.sort. Doc from com.badlogic.gdx.utils.Array.sort. Sorts the array. This method is not thread safe (uses `Sort#instance()`).

public void sort(Comparator<? super T> comparator)

Overrides com.badlogic.gdx.utils.Array.sort.

Doc from com.badlogic.gdx.utils.Array.sort.

Sorts the array. This method is not thread safe (uses Sort#instance()).

swap	back to summary
public void swap(int first, int second) Overrides com.badlogic.gdx.utils.Array.swap.

truncate	back to summary
public void truncate(int newSize) Overrides com.badlogic.gdx.utils.Array.truncate. Doc from com.badlogic.gdx.utils.Array.truncate. Reduces the size of the array to the specified size. If the array is already smaller than the specified size, no action is taken.

truncate

back to summary

public void truncate(int newSize)

Overrides com.badlogic.gdx.utils.Array.truncate.

Doc from com.badlogic.gdx.utils.Array.truncate.

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

with back to summary

with	back to summary
public static <T> SnapshotArray<T> with(T... array) Hides com.badlogic.gdx.utils.Array.with. See Also `SnapshotArray(Object[])`

public static <T> SnapshotArray<T> with(T... array)

Hides com.badlogic.gdx.utils.Array.with.

See Also: SnapshotArray(Object[])

public Class SnapshotArray<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail