ConcurrentShortQueue (mini2Dx-core 2.0.0-beta.7 API)

java.lang.Object
- org.mini2Dx.core.collections.ShortQueue
- - org.mini2Dx.core.collections.concurrent.ConcurrentShortQueue

All Implemented Interfaces:: ConcurrentCollection

public class ConcurrentShortQueue
extends ShortQueue
implements ConcurrentCollection

Nested Class Summary
- Nested classes/interfaces inherited from class org.mini2Dx.core.collections.ShortQueue
  ShortQueue.ShortQueueIterable, ShortQueue.ShortQueueIterator

Field Summary

Fields
Modifier and Type Field and Description

protected org.mini2Dx.lockprovider.ReadWriteLock lock
- Fields inherited from class org.mini2Dx.core.collections.ShortQueue
  head, size, tail, values

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

Constructor Summary

Constructors
Constructor and Description
`ConcurrentShortQueue()` Creates a new Queue which can hold 16 values without needing to resize backing array.
`ConcurrentShortQueue(int initialSize)` Creates a new Queue which can hold the specified number of values without needing to resize backing array.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFirst(short object)` Prepend given object to the head.
`void`	`addLast(short 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)`
`short`	`first()` Returns the first (head) item in the queue (without removing it).
`short`	`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(short 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.Short>`	`iterator()` Returns an iterator for the items in the queue.
`short`	`last()` Returns the last (tail) item in the queue (without removing it).
`boolean`	`notEmpty()` Returns true if the queue has one or more items.
`short`	`removeFirst()` Remove the first item from the queue.
`short`	`removeIndex(int index)` Removes and returns the item at the specified index.
`short`	`removeLast()` Remove the last item from the queue.
`boolean`	`removeValue(short 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.ShortQueue
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
  - ConcurrentShortQueue
```
public ConcurrentShortQueue()
```
    Creates a new Queue which can hold 16 values without needing to resize backing array.
  - ConcurrentShortQueue
```
public ConcurrentShortQueue(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(short object)
```
    Append given object to the tail. (enqueue to tail) Unless backing array needs resizing, operates in O(1) time.
    
    Overrides:
    
    addLast in class ShortQueue
    
    Parameters:
    
    object - can be null
  - addFirst
```
public void addFirst(short object)
```
    Prepend given object to the head. (enqueue to head) Unless backing array needs resizing, operates in O(1) time.
    
    Overrides:
    
    addFirst in class ShortQueue
    
    Parameters:
    
    object - can be null
    
    See Also:
    
    addLast(short)
  - 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 ShortQueue
    
    Parameters:
    
    additional -
  - removeFirst
```
public short removeFirst()
```
    Remove the first item from the queue. (dequeue from head) Always O(1).
    
    Overrides:
    
    removeFirst in class ShortQueue
    
    Returns:
    
    removed object
    
    Throws:
    
    java.util.NoSuchElementException - when queue is empty
  - removeLast
```
public short removeLast()
```
    Remove the last item from the queue. (dequeue from tail) Always O(1).
    
    Overrides:
    
    removeLast in class ShortQueue
    
    Returns:
    
    removed object
    
    Throws:
    
    java.util.NoSuchElementException - when queue is empty
    
    See Also:
    
    removeFirst()
  - indexOf
```
public int indexOf(short value)
```
    Returns the index of first occurrence of value in the queue, or -1 if no such value exists.
    
    Overrides:
    
    indexOf in class ShortQueue
    
    Parameters:
    
    value -
    
    Returns:
    
    An index of first occurrence of value in queue or -1 if no such value exists
  - removeValue
```
public boolean removeValue(short value)
```
    Removes the first instance of the specified value in the queue.
    
    Overrides:
    
    removeValue in class ShortQueue
    
    Parameters:
    
    value -
    
    Returns:
    
    true if value was found and removed, false otherwise
  - removeIndex
```
public short removeIndex(int index)
```
    Removes and returns the item at the specified index.
    
    Overrides:
    
    removeIndex in class ShortQueue
    
    Parameters:
    
    index -
  - notEmpty
```
public boolean notEmpty()
```
    Returns true if the queue has one or more items.
    
    Overrides:
    
    notEmpty in class ShortQueue
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if the queue is empty.
    
    Overrides:
    
    isEmpty in class ShortQueue
  - first
```
public short first()
```
    Returns the first (head) item in the queue (without removing it).
    
    Overrides:
    
    first in class ShortQueue
    
    Throws:
    
    java.util.NoSuchElementException - when queue is empty
    
    See Also:
    
    addFirst(short), removeFirst()
  - last
```
public short last()
```
    Returns the last (tail) item in the queue (without removing it).
    
    Overrides:
    
    last in class ShortQueue
    
    Throws:
    
    java.util.NoSuchElementException - when queue is empty
    
    See Also:
    
    addLast(short), removeLast()
  - get
```
public short 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 ShortQueue
    
    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 ShortQueue
  - iterator
```
public java.util.Iterator<java.lang.Short> iterator()
```
    Returns an iterator for the items in the queue. Remove is supported.
    
    Overrides:
    
    iterator in class ShortQueue
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class ShortQueue
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class ShortQueue
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class ShortQueue
  - toString
```
public java.lang.String toString(java.lang.String separator)
```
    Overrides:
    
    toString in class ShortQueue
  - 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

Class ConcurrentShortQueue

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

lock

Constructor Detail

ConcurrentShortQueue

ConcurrentShortQueue

Method Detail

size

addLast

addFirst

ensureCapacity

removeFirst

removeLast

indexOf

removeValue

removeIndex

notEmpty

isEmpty

first

last

get

clear

iterator

hashCode

equals

toString

toString

getLock