CharArrayFIFOQueue (Primitive-Collections 0.2.0 API)

java.lang.Object
- speiger.src.collections.chars.queues.CharArrayFIFOQueue

All Implemented Interfaces:

java.lang.Iterable<java.lang.Character>, CharIterable, CharPriorityDequeue, CharPriorityQueue, ObjectPriorityQueue<java.lang.Character>, ITrimmable
```
public class CharArrayFIFOQueue
extends java.lang.Object
implements CharPriorityDequeue, ITrimmable
```
A Simple First In First Out Priority Queue that is a Good Replacement for a linked list (or ArrayDequeue) Its specific implementation uses a backing array that grows and shrinks as it is needed.

Field Summary

Fields
Modifier and Type Field and Description

static int MIN_CAPACITY
The Minimum Capacity that is allowed

Fields
Modifier and Type	Field and Description
`static int`	`MIN_CAPACITY` The Minimum Capacity that is allowed

Constructor Summary

Constructors
Constructor and Description
`CharArrayFIFOQueue()` Default Construtor
`CharArrayFIFOQueue(char[] values)` Constructor using a initial array
`CharArrayFIFOQueue(char[] values, int size)` Constructor using a initial array
`CharArrayFIFOQueue(char[] values, int offset, int size)` Constructor using a initial array
`CharArrayFIFOQueue(int capacity)` Constructor with a Min Capacity

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` clears all elements within the PriorityQueue, this does not resize the backing arrays
`void`	`clearAndTrim(int size)` Trims the collection down to the requested size and clears all elements while doing so
`CharComparator`	`comparator()`
`char`	`dequeueChar()` Method to extract a element from the PriorityQueue
`char`	`dequeueLastChar()` A Method to remove a element from the last place instead of the first
`void`	`enqueueChar(char e)` Method to insert a element into the PriorityQueue
`void`	`enqueueFirstChar(char e)` Method to insert a element into the first Index instead of the last.
`CharIterator`	`iterator()` Returns an iterator over elements of type `T`.
`void`	`onChanged()` Allows to notify the Queue to be revalidate its data
`char`	`peekChar(int index)` Peeking function to see whats inside the queue.
`boolean`	`removeChar(char e)` Removes the first found element in the queue
`boolean`	`removeLastChar(char e)` Removes the last found element in the queue
`int`	`size()`
`java.lang.Character[]`	`toArray(java.lang.Character[] input)` A method to drop the contents of the Queue without clearing the queue
`char[]`	`toCharArray(char[] input)` A method to drop the contents of the Queue without clearing the queue
`boolean`	`trim(int size)` Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface speiger.src.collections.chars.queues.CharPriorityDequeue
dequeueLast, enqueueFirst, last, lastChar

Methods inherited from interface speiger.src.collections.chars.queues.CharPriorityQueue
dequeue, enqueue, first, firstChar, peek, remove, removeLast, toArray, toCharArray

Methods inherited from interface speiger.src.collections.objects.queues.ObjectPriorityQueue
isEmpty

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable
forEach, forEach, spliterator

Methods inherited from interface speiger.src.collections.utils.ITrimmable
clearAndTrim, trim

- Field Detail
  - MIN_CAPACITY
```
public static final int MIN_CAPACITY
```
    The Minimum Capacity that is allowed
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CharArrayFIFOQueue
```
public CharArrayFIFOQueue(char[] values)
```
    Constructor using a initial array
    
    Parameters:
    
    values - the Array that should be used
  - CharArrayFIFOQueue
```
public CharArrayFIFOQueue(char[] values,
                          int size)
```
    Constructor using a initial array
    
    Parameters:
    
    values - the Array that should be used
    
    size - the amount of elements that are in the initial array
    
    Throws:
    
    java.lang.IllegalStateException - if values is smaller then size
  - CharArrayFIFOQueue
```
public CharArrayFIFOQueue(char[] values,
                          int offset,
                          int size)
```
    Constructor using a initial array
    
    Parameters:
    
    values - the Array that should be used
    
    offset - where to begin in the initial array
    
    size - the amount of elements that are in the initial array
    
    Throws:
    
    java.lang.IllegalStateException - if values is smaller then size
  - CharArrayFIFOQueue
```
public CharArrayFIFOQueue(int capacity)
```
    Constructor with a Min Capacity
    
    Parameters:
    
    capacity - the initial capacity of the backing array
    
    Throws:
    
    java.lang.IllegalStateException - if the initial size is smaller 0
  - CharArrayFIFOQueue
```
public CharArrayFIFOQueue()
```
    Default Construtor
- Method Detail
  - iterator
```
public CharIterator iterator()
```
    Description copied from interface: CharIterable
    
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Character>
    
    Specified by:
    
    iterator in interface CharIterable
    
    Returns:
    
    an Iterator.
  - size
```
public int size()
```
    Specified by:
    
    size in interface ObjectPriorityQueue<java.lang.Character>
    
    Returns:
    
    the amount of elements that are stored in the PriorityQueue
  - clear
```
public void clear()
```
    Description copied from interface: ObjectPriorityQueue
    
    clears all elements within the PriorityQueue, this does not resize the backing arrays
    
    Specified by:
    
    clear in interface ObjectPriorityQueue<java.lang.Character>
  - enqueueChar
```
public void enqueueChar(char e)
```
    Description copied from interface: CharPriorityQueue
    
    Method to insert a element into the PriorityQueue
    
    Specified by:
    
    enqueueChar in interface CharPriorityQueue
    
    Parameters:
    
    e - the element that should be inserted
  - enqueueFirstChar
```
public void enqueueFirstChar(char e)
```
    Description copied from interface: CharPriorityDequeue
    
    Method to insert a element into the first Index instead of the last.
    
    Specified by:
    
    enqueueFirstChar in interface CharPriorityDequeue
    
    Parameters:
    
    e - the element that should be inserted into the first place
  - dequeueChar
```
public char dequeueChar()
```
    Description copied from interface: CharPriorityQueue
    
    Method to extract a element from the PriorityQueue
    
    Specified by:
    
    dequeueChar in interface CharPriorityQueue
    
    Returns:
    
    a element from the Queue
  - dequeueLastChar
```
public char dequeueLastChar()
```
    Description copied from interface: CharPriorityDequeue
    
    A Method to remove a element from the last place instead of the first
    
    Specified by:
    
    dequeueLastChar in interface CharPriorityDequeue
    
    Returns:
    
    the last element inserted
  - peekChar
```
public char peekChar(int index)
```
    Description copied from interface: CharPriorityQueue
    
    Peeking function to see whats inside the queue.
    
    Specified by:
    
    peekChar in interface CharPriorityQueue
    
    Parameters:
    
    index - of the element that is requested to be viewed.
    
    Returns:
    
    the element that is requested
  - removeChar
```
public boolean removeChar(char e)
```
    Description copied from interface: CharPriorityQueue
    
    Removes the first found element in the queue
    
    Specified by:
    
    removeChar in interface CharPriorityQueue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - removeLastChar
```
public boolean removeLastChar(char e)
```
    Description copied from interface: CharPriorityQueue
    
    Removes the last found element in the queue
    
    Specified by:
    
    removeLastChar in interface CharPriorityQueue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - onChanged
```
public void onChanged()
```
    Description copied from interface: CharPriorityQueue
    
    Allows to notify the Queue to be revalidate its data
    
    Specified by:
    
    onChanged in interface CharPriorityQueue
    
    Specified by:
    
    onChanged in interface ObjectPriorityQueue<java.lang.Character>
  - comparator
```
public CharComparator comparator()
```
    Specified by:
    
    comparator in interface CharPriorityQueue
    
    Specified by:
    
    comparator in interface ObjectPriorityQueue<java.lang.Character>
    
    Returns:
    
    the sorter of the Queue, can be null
  - trim
```
public boolean trim(int size)
```
    Description copied from interface: ITrimmable
    
    Trims the original collection down to the size of the current elements or the requested size depending which is bigger
    
    Specified by:
    
    trim in interface ITrimmable
    
    Parameters:
    
    size - the requested trim size.
    
    Returns:
    
    if the internal array has been trimmed.
  - clearAndTrim
```
public void clearAndTrim(int size)
```
    Trims the collection down to the requested size and clears all elements while doing so
    
    Specified by:
    
    clearAndTrim in interface ITrimmable
    
    Parameters:
    
    size - the amount of elements that should be allowed
    
    Note:
    
    this will enforce minimum size of the collection itself
  - toCharArray
```
public char[] toCharArray(char[] input)
```
    Description copied from interface: CharPriorityQueue
    
    A method to drop the contents of the Queue without clearing the queue
    
    Specified by:
    
    toCharArray in interface CharPriorityQueue
    
    Parameters:
    
    input - where the elements should be inserted to. If it does not fit then it creates a new appropiatly created array
    
    Returns:
    
    the contents of the queue into a seperate array.
  - toArray
```
public java.lang.Character[] toArray(java.lang.Character[] input)
```
    Description copied from interface: ObjectPriorityQueue
    
    A method to drop the contents of the Queue without clearing the queue
    
    Specified by:
    
    toArray in interface CharPriorityQueue
    
    Specified by:
    
    toArray in interface ObjectPriorityQueue<java.lang.Character>
    
    Parameters:
    
    input - where the elements should be inserted to. If it does not fit then it creates a new appropiatly created array
    
    Returns:
    
    the contents of the queue into a seperate array.

Class CharArrayFIFOQueue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.chars.queues.CharPriorityDequeue

Methods inherited from interface speiger.src.collections.chars.queues.CharPriorityQueue

Methods inherited from interface speiger.src.collections.objects.queues.ObjectPriorityQueue

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable

Methods inherited from interface speiger.src.collections.utils.ITrimmable

Field Detail

MIN_CAPACITY

Constructor Detail

CharArrayFIFOQueue

CharArrayFIFOQueue

CharArrayFIFOQueue

CharArrayFIFOQueue

CharArrayFIFOQueue

Method Detail

iterator

size

clear

enqueueChar

enqueueFirstChar

dequeueChar

dequeueLastChar

peekChar

removeChar

removeLastChar

onChanged

comparator

trim

clearAndTrim

toCharArray

toArray