CharQueue (mini2Dx)

java.lang.Object
- org.mini2Dx.core.collections.CharQueue

public class CharQueue
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CharQueue.CharQueueIterable

static class CharQueue.CharQueueIterator

Nested Classes
Modifier and Type	Class and Description
`static class`	`CharQueue.CharQueueIterable`
`static class`	`CharQueue.CharQueueIterator`

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`head` Index of first element.
`int`	`size` Number of elements in the queue.
`protected int`	`tail` Index of last element.
`protected char[]`	`values` Contains the values in the queue.

Constructor Summary

Constructors
Constructor and Description
`CharQueue()` Creates a new Queue which can hold 16 values without needing to resize backing array.
`CharQueue(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(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 o)`
`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.
`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.
`protected void`	`resize(int newSize)` Resize backing array.
`java.lang.String`	`toString()`
`java.lang.String`	`toString(java.lang.String separator)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - values
```
protected char[] values
```
    Contains the values in the queue. Head and tail indices go in a circle around this array, wrapping at the end.
  - head
```
protected int head
```
    Index of first element. Logically smaller than tail. Unless empty, it points to a valid element inside queue.
  - tail
```
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).
  - size
```
public int size
```
    Number of elements in the queue.
- Constructor Detail
  - CharQueue
```
public CharQueue()
```
    Creates a new Queue which can hold 16 values without needing to resize backing array.
  - CharQueue
```
public CharQueue(int initialSize)
```
    Creates a new Queue which can hold the specified number of values without needing to resize backing array.
- Method Detail
  - 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.
    
    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.
    
    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.
  - resize
```
protected void resize(int newSize)
```
    Resize backing array. newSize must be bigger than current size.
  - removeFirst
```
public char removeFirst()
```
    Remove the first item from the queue. (dequeue from head) Always O(1).
    
    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).
    
    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.
    
    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.
    
    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.
  - notEmpty
```
public boolean notEmpty()
```
    Returns true if the queue has one or more items.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if the queue is empty.
  - first
```
public char first()
```
    Returns the first (head) item in the queue (without removing it).
    
    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).
    
    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().
    
    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).
  - iterator
```
public java.util.Iterator<java.lang.Character> iterator()
```
    Returns an iterator for the items in the queue. Remove is supported.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(java.lang.String separator)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object

Class CharQueue

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

values

head

tail

size

Constructor Detail

CharQueue

CharQueue

Method Detail

addLast

addFirst

ensureCapacity

resize

removeFirst

removeLast

indexOf

removeValue

removeIndex

notEmpty

isEmpty

first

last

get

clear

iterator

toString

toString

hashCode

equals