org.mini2Dx.core.collections.concurrent

Class ConcurrentCharQueue

java.lang.Object

org.mini2Dx.core.collections.CharQueue

org.mini2Dx.core.collections.concurrent.ConcurrentCharQueue

All Implemented Interfaces:

ConcurrentCollection

public class ConcurrentCharQueue
extends CharQueue
implements ConcurrentCollection

Nested Class Summary

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

CharQueue.CharQueueIterable, CharQueue.CharQueueIterator

Field Summary

Fields

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

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

head, size, tail, values

Constructor Summary

Constructors

Constructor and Description
ConcurrentCharQueue() Creates a new Queue which can hold 16 values without needing to resize backing array.
ConcurrentCharQueue(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(char object) Prepend given object to the head.
void	addLast(char 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)
char	first() Returns the first (head) item in the queue (without removing it).
char	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(char 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.Character>	iterator() Returns an iterator for the items in the queue.
char	last() Returns the last (tail) item in the queue (without removing it).
boolean	notEmpty() Returns true if the queue has one or more items.
char	removeFirst() Remove the first item from the queue.
char	removeIndex(int index) Removes and returns the item at the specified index.
char	removeLast() Remove the last item from the queue.
boolean	removeValue(char 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.CharQueue

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

ConcurrentCharQueue

public ConcurrentCharQueue()

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

ConcurrentCharQueue

public ConcurrentCharQueue(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(char object)

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

Overrides:

addLast in class CharQueue

Parameters:

object - can be null

addFirst

public void addFirst(char object)

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

Overrides:

addFirst in class CharQueue

Parameters:

object - can be null

See Also:

addLast(char)

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 CharQueue

Parameters:

additional -

removeFirst

public char removeFirst()

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

Overrides:

removeFirst in class CharQueue

Returns:

removed object

Throws:

java.util.NoSuchElementException - when queue is empty

removeLast

public char removeLast()

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

Overrides:

removeLast in class CharQueue

Returns:

removed object

Throws:

java.util.NoSuchElementException - when queue is empty

See Also:

removeFirst()

indexOf

public int indexOf(char value)

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

Overrides:

indexOf in class CharQueue

Parameters:

value -

Returns:

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

removeValue

public boolean removeValue(char value)

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

Overrides:

removeValue in class CharQueue

Parameters:

value -

Returns:

true if value was found and removed, false otherwise

removeIndex

public char removeIndex(int index)

Removes and returns the item at the specified index.

Overrides:

removeIndex in class CharQueue

Parameters:

index -

notEmpty

public boolean notEmpty()

Returns true if the queue has one or more items.

Overrides:

notEmpty in class CharQueue

isEmpty

public boolean isEmpty()

Returns true if the queue is empty.

Overrides:

isEmpty in class CharQueue

first

public char first()

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

Overrides:

first in class CharQueue

Throws:

java.util.NoSuchElementException - when queue is empty

See Also:

addFirst(char), removeFirst()

last

public char last()

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

Overrides:

last in class CharQueue

Throws:

java.util.NoSuchElementException - when queue is empty

See Also:

addLast(char), removeLast()

get

public char 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 CharQueue

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 CharQueue

iterator

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

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

Overrides:

iterator in class CharQueue

hashCode

public int hashCode()

Overrides:

hashCode in class CharQueue

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class CharQueue

toString

public java.lang.String toString()

Overrides:

toString in class CharQueue

toString

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

Overrides:

toString in class CharQueue

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