Modifier and Type	Class and Description
public static class	Queue.QueueIterable<T>
public static class	Queue.QueueIterator<T>

Modifier and Type	Field and Description
protected int	head Index of first element.
private transient Queue.QueueIterable<T>	iterable
public int	size Number of elements in the queue.
protected int	tail Index of last element.
protected T[]	values Contains the values in the queue.

Access	Constructor and Description
public	Queue() Creates a new Queue which can hold 16 values without needing to resize backing array.
public	Queue(int initialSize) Creates a new Queue which can hold the specified number of values without needing to resize backing array.
public	Queue(int initialSize, Class<T> type) Deprecated Use `Queue#Queue(int, ArraySupplier)` instead Creates a new Queue which can hold the specified number of values without needing to resize backing array.
public	Queue(int initialSize, ArraySupplier<T[]> arraySupplier) Creates a new Queue which can hold the specified number of values without needing to resize backing array.

Method Summary

Modifier and Type	Method and Description
public void	addFirst(T can be null object) Prepend given object to the head.
public void	addLast(T can be null object) Append given object to the tail.
public void	clear() Removes all values from this queue.
public void	ensureCapacity(int additional) Increases the size of the backing array to accommodate the specified number of additional items.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public boolean	equalsIdentity(Object o) Uses == for comparison of each item.
public T	first() Returns the first (head) item in the queue (without removing it).
public T	get(int index) Retrieves the value in queue without removing it.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	Returns: An index of first occurrence of value in queue or -1 if no such value exists indexOf(T value, boolean If true, == comparison will be used. If false, .equals() comparison will be used. identity) Returns the index of first occurrence of value in the queue, or -1 if no such value exists.
public boolean	isEmpty() Returns true if the queue is empty.
public Iterator<T>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator for the items in the queue.
public T	last() Returns the last (tail) item in the queue (without removing it).
public boolean	notEmpty() Returns true if the queue has one or more items.
public T	Returns: removed object removeFirst() Remove the first item from the queue.
public T	removeIndex(int index) Removes and returns the item at the specified index.
public T	Returns: removed object removeLast() Remove the last item from the queue.
public boolean	Returns: true if value was found and removed, false otherwise removeValue(T value, boolean If true, == comparison will be used. If false, .equals() comparison will be used. identity) Removes the first instance of the specified value in the queue.
protected void	resize(int newSize) Resize backing array.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	toString(String separator)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

head	back to summary
protected int head Index of first element. Logically smaller than tail. Unless empty, it points to a valid element inside queue.

iterable	back to summary
private transient Queue.QueueIterable<T> iterable

size	back to summary
public int size Number of elements in the queue.

tail	back to summary
protected int tail Index of last element. Logically bigger than head. Usually points to an empty position, but points to the head when full (size == values.length).

values	back to summary
protected T[] values Contains the values in the queue. Head and tail indices go in a circle around this array, wrapping at the end.

Constructor Detail

Queue	back to summary
public Queue() Creates a new Queue which can hold 16 values without needing to resize backing array.

Queue	back to summary
public Queue(int initialSize) Creates a new Queue which can hold the specified number of values without needing to resize backing array.

Queue back to summary

Queue	back to summary
public Queue(int initialSize, Class<T> type) Deprecated Use `Queue#Queue(int, ArraySupplier)` instead Creates a new Queue which can hold the specified number of values without needing to resize backing array. This creates backing array of the specified type via reflection, which is necessary only when accessing the backing array directly. Annotations @Deprecated

public Queue(int initialSize, Class<T> type)

Deprecated

Use Queue#Queue(int, ArraySupplier) instead

Creates a new Queue which can hold the specified number of values without needing to resize backing array. This creates backing array of the specified type via reflection, which is necessary only when accessing the backing array directly.

Annotations

@Deprecated

Queue	back to summary
public Queue(int initialSize, ArraySupplier<T[]> arraySupplier) Creates a new Queue which can hold the specified number of values without needing to resize backing array. This creates backing array of the specified type via the supplier, which is necessary only when accessing the backing array directly.

Method Detail

addFirst back to summary

addFirst	back to summary
public void addFirst(T object) Prepend given object to the head. (enqueue to head) Unless backing array needs resizing, operates in O(1) time. Parameters object:T can be null See Also `addLast(Object)`

public void addFirst(T object)

Prepend given object to the head. (enqueue to head) Unless backing array needs resizing, operates in O(1) time.

Parameters

object:T: can be null

See Also

addLast(Object)

addLast	back to summary
public void addLast(T object) Append given object to the tail. (enqueue to tail) Unless backing array needs resizing, operates in O(1) time. Parameters object:T can be null

addLast

back to summary

public void addLast(T object)

Append given object to the tail. (enqueue to tail) Unless backing array needs resizing, operates in O(1) time.

Parameters

object:T: can be null

clear	back to summary
public void clear() Removes all values from this queue. Values in backing array are set to null to prevent memory leak, so this operates in O(n).

ensureCapacity	back to summary
public void ensureCapacity(int additional) 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.

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

equalsIdentity	back to summary
public boolean equalsIdentity(Object o) Uses == for comparison of each item.

first back to summary

first	back to summary
public T first() Returns the first (head) item in the queue (without removing it). Exceptions NoSuchElementException: when queue is empty See Also `addFirst(Object)`, `removeFirst()`

public T first()

Returns the first (head) item in the queue (without removing it).

Exceptions

NoSuchElementException:: when queue is empty

See Also

addFirst(Object), removeFirst()

get back to summary

get	back to summary
public T get(int index) Retrieves the value in queue without removing it. Indexing is from the front to back, zero based. Therefore get(0) is the same as `first()`. Exceptions IndexOutOfBoundsException: when the index is negative or >= size

public T get(int index)

Retrieves the value in queue without removing it. Indexing is from the front to back, zero based. Therefore get(0) is the same as first().

Exceptions

IndexOutOfBoundsException:: when the index is negative or >= size

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

indexOf	back to summary
public int indexOf(T value, boolean identity) Returns the index of first occurrence of value in the queue, or -1 if no such value exists. Parameters identity:boolean If true, == comparison will be used. If false, .equals() comparison will be used. Returns:int An index of first occurrence of value in queue or -1 if no such value exists

indexOf

back to summary

public int indexOf(T value, boolean identity)

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

Parameters

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

Returns:int

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

isEmpty	back to summary
public boolean isEmpty() Returns true if the queue is empty.

iterator back to summary

iterator	back to summary
public Iterator<T> iterator() Implements java.lang.Iterable.iterator. Returns an iterator for the items in the queue. Remove is supported. If `Collections#allocateIterators` is false, the same iterator instance is returned each time this method is called. Use the `QueueIterator` constructor for nested or multithreaded iteration.

public Iterator<T> iterator()

Implements java.lang.Iterable.iterator.

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

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

last back to summary

last	back to summary
public T last() Returns the last (tail) item in the queue (without removing it). Exceptions NoSuchElementException: when queue is empty See Also `addLast(Object)`, `removeLast()`

public T last()

Returns the last (tail) item in the queue (without removing it).

Exceptions

NoSuchElementException:: when queue is empty

See Also

addLast(Object), removeLast()

notEmpty	back to summary
public boolean notEmpty() Returns true if the queue has one or more items.

removeFirst	back to summary
public T removeFirst() Remove the first item from the queue. (dequeue from head) Always O(1). Returns:T removed object Exceptions NoSuchElementException: when queue is empty

removeFirst

back to summary

public T removeFirst()

Remove the first item from the queue. (dequeue from head) Always O(1).

Returns:T

removed object

Exceptions

NoSuchElementException:: when queue is empty

removeIndex	back to summary
public T removeIndex(int index) Removes and returns the item at the specified index.

removeLast back to summary

removeLast	back to summary
public T removeLast() Remove the last item from the queue. (dequeue from tail) Always O(1). Returns:T removed object Exceptions NoSuchElementException: when queue is empty See Also `removeFirst()`

public T removeLast()

Remove the last item from the queue. (dequeue from tail) Always O(1).

Returns:T

removed object

Exceptions

NoSuchElementException:: when queue is empty

See Also

removeFirst()

removeValue	back to summary
public boolean removeValue(T value, boolean identity) Removes the first instance of the specified value in the queue. Parameters identity:boolean If true, == comparison will be used. If false, .equals() comparison will be used. Returns:boolean true if value was found and removed, false otherwise

removeValue

back to summary

public boolean removeValue(T value, boolean identity)

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

Parameters

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

Returns:boolean

true if value was found and removed, false otherwise

resize	back to summary
protected void resize(int newSize) Resize backing array. newSize must be bigger than current size.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

toString	back to summary
public String toString(String separator)

com.badlogic.gdx.utils back to summary

public Class Queue.QueueIterable<T>

Class Inheritance

extends Object
implements Iterable<T>

java.lang.Object
com.badlogic.gdx.utils.Queue.QueueIterable

All Implemented Interfaces

java.lang.Iterable

Field Summary

Modifier and Type	Field and Description
private final boolean	allowRemove
private Queue.QueueIterator<T>	iterator1
private Queue.QueueIterator<T>	iterator2
private final Queue<T>	queue

Constructor Summary

Access	Constructor and Description
public	QueueIterable(Queue<T> queue)
public	QueueIterable(Queue<T> queue, boolean allowRemove)

Method Summary

Modifier and Type	Method and Description
public Iterator<T>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allowRemove	back to summary
private final boolean allowRemove

iterator1	back to summary
private Queue.QueueIterator<T> iterator1

iterator2	back to summary
private Queue.QueueIterator<T> iterator2

queue	back to summary
private final Queue<T> queue

Constructor Detail

QueueIterable	back to summary
public QueueIterable(Queue<T> queue)

QueueIterable	back to summary
public QueueIterable(Queue<T> queue, boolean allowRemove)

Method Detail

iterator back to summary

iterator	back to summary
public Iterator<T> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. See Also `Collections#allocateIterators`

public Iterator<T> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

See Also: Collections#allocateIterators

com.badlogic.gdx.utils back to summary

public Class Queue.QueueIterator<T>

Class Inheritance

extends Object
implements Iterator<T>, Iterable<T>

java.lang.Object
com.badlogic.gdx.utils.Queue.QueueIterator

All Implemented Interfaces

java.lang.Iterable, java.util.Iterator

Field Summary

Modifier and Type	Field and Description
private final boolean	allowRemove
pack-priv int	index
private final Queue<T>	queue
pack-priv boolean	valid

Constructor Summary

Access	Constructor and Description
public	QueueIterator(Queue<T> queue)
public	QueueIterator(Queue<T> queue, boolean allowRemove)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Iterator<T>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public T	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).
public void	reset()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allowRemove	back to summary
private final boolean allowRemove

index	back to summary
pack-priv int index

queue	back to summary
private final Queue<T> queue

valid	back to summary
pack-priv boolean valid

Constructor Detail

QueueIterator	back to summary
public QueueIterator(Queue<T> queue)

QueueIterator	back to summary
public QueueIterator(Queue<T> queue, boolean allowRemove)

Method Detail

hasNext back to summary

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

iterator back to summary

public Iterator<T> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

back to summary

public T next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

remove back to summary

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

reset	back to summary
public void reset()

public Class Queue<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Queue.QueueIterable<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Queue.QueueIterator<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail