org.mini2Dx.core.collections.concurrent

Class ConcurrentLongQueue

java.lang.Object

org.mini2Dx.core.collections.LongQueue

org.mini2Dx.core.collections.concurrent.ConcurrentLongQueue

All Implemented Interfaces:

ConcurrentCollection

public class ConcurrentLongQueue
extends LongQueue
implements ConcurrentCollection

Nested Class Summary

Nested classes/interfaces inherited from class org.mini2Dx.core.collections.LongQueue

LongQueue.LongQueueIterable, LongQueue.LongQueueIterator

Field Summary

Fields

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

Fields inherited from class org.mini2Dx.core.collections.LongQueue

head, size, tail, values

Constructor Summary

Constructors

Constructor and Description
ConcurrentLongQueue() Creates a new Queue which can hold 16 values without needing to resize backing array.
ConcurrentLongQueue(int initialSize) 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
void	addFirst(long object) Prepend given object to the head.
void	addLast(long object) Append given object to the tail.
void	clear() Removes all values from this queue.
void	ensureCapacity(int additional) Increases the size of the backing array to accommodate the specified number of additional items.
boolean	equals(java.lang.Object object)
long	first() Returns the first (head) item in the queue (without removing it).
long	get(int index) Retrieves the value in queue without removing it.
org.mini2Dx.lockprovider.ReadWriteLock	getLock() Returns the collection's ReadWriteLock
int	hashCode()
int	indexOf(long value) Returns the index of first occurrence of value in the queue, or -1 if no such value exists.
boolean	isEmpty() Returns true if the queue is empty.
java.util.Iterator<java.lang.Long>	iterator() Returns an iterator for the items in the queue.
long	last() Returns the last (tail) item in the queue (without removing it).
boolean	notEmpty() Returns true if the queue has one or more items.
long	removeFirst() Remove the first item from the queue.
long	removeIndex(int index) Removes and returns the item at the specified index.
long	removeLast() Remove the last item from the queue.
boolean	removeValue(long value) Removes the first instance of the specified value in the queue.
int	size() Returns the size in a thread-safe manner
java.lang.String	toString()
java.lang.String	toString(java.lang.String separator)

Methods inherited from class org.mini2Dx.core.collections.LongQueue

resize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

lock

protected org.mini2Dx.lockprovider.ReadWriteLock lock

Constructor Detail

ConcurrentLongQueue

public ConcurrentLongQueue()

Creates a new Queue which can hold 16 values without needing to resize backing array.

ConcurrentLongQueue

public ConcurrentLongQueue(int initialSize)

Creates a new Queue which can hold the specified number of values without needing to resize backing array.

Parameters:

initialSize -

Method Detail

size

public int size()

Returns the size in a thread-safe manner

Returns:

0 if empty

addLast

public void addLast(long object)

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

Overrides:

addLast in class LongQueue

Parameters:

object - can be null

addFirst

public void addFirst(long object)

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

Overrides:

addFirst in class LongQueue

Parameters:

object - can be null

See Also:

addLast(long)

ensureCapacity

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.

Overrides:

ensureCapacity in class LongQueue

Parameters:

additional -

removeFirst

public long removeFirst()

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

Overrides:

removeFirst in class LongQueue

Returns:

removed object

Throws:

java.util.NoSuchElementException - when queue is empty

removeLast

public long removeLast()

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

Overrides:

removeLast in class LongQueue

Returns:

removed object

Throws:

java.util.NoSuchElementException - when queue is empty

See Also:

removeFirst()

indexOf

public int indexOf(long value)

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

Overrides:

indexOf in class LongQueue

Parameters:

value -

Returns:

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

removeValue

public boolean removeValue(long value)

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

Overrides:

removeValue in class LongQueue

Parameters:

value -

Returns:

true if value was found and removed, false otherwise

removeIndex

public long removeIndex(int index)

Removes and returns the item at the specified index.

Overrides:

removeIndex in class LongQueue

Parameters:

index -

notEmpty

public boolean notEmpty()

Returns true if the queue has one or more items.

Overrides:

notEmpty in class LongQueue

isEmpty

public boolean isEmpty()

Returns true if the queue is empty.

Overrides:

isEmpty in class LongQueue

first

public long first()

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

Overrides:

first in class LongQueue

Throws:

java.util.NoSuchElementException - when queue is empty

See Also:

addFirst(long), removeFirst()

last

public long last()

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

Overrides:

last in class LongQueue

Throws:

java.util.NoSuchElementException - when queue is empty

See Also:

addLast(long), removeLast()

get

public long 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().

Overrides:

get in class LongQueue

Parameters:

index -

Throws:

java.lang.IndexOutOfBoundsException - when the index is negative or greater or equal than size

clear

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).

Overrides:

clear in class LongQueue

iterator

public java.util.Iterator<java.lang.Long> iterator()

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

Overrides:

iterator in class LongQueue

hashCode

public int hashCode()

Overrides:

hashCode in class LongQueue

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class LongQueue

toString

public java.lang.String toString()

Overrides:

toString in class LongQueue

toString

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

Overrides:

toString in class LongQueue

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