CharPriorityQueue (Primitive-Collections 0.2.0 API)

All Superinterfaces:

CharIterable, java.lang.Iterable<java.lang.Character>, ObjectPriorityQueue<java.lang.Character>

All Known Subinterfaces:

CharPriorityDequeue

All Known Implementing Classes:

CharArrayFIFOQueue, CharArrayPriorityQueue, CharHeapPriorityQueue
```
public interface CharPriorityQueue
extends ObjectPriorityQueue<java.lang.Character>, CharIterable
```
A Simple PriorityQueue (or Queue) interface that provides with the nessesary functions to interact with it, without cluttering with the Collection interface.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`CharComparator`	`comparator()`
`default java.lang.Character`	`dequeue()` Deprecated.
`char`	`dequeueChar()` Method to extract a element from the PriorityQueue
`default void`	`enqueue(java.lang.Character e)` Deprecated.
`void`	`enqueueChar(char e)` Method to insert a element into the PriorityQueue
`default java.lang.Character`	`first()` Deprecated.
`default char`	`firstChar()` Shows the element that is to be returned next
`void`	`onChanged()` Allows to notify the Queue to be revalidate its data
`default java.lang.Character`	`peek(int index)` Deprecated.
`char`	`peekChar(int index)` Peeking function to see whats inside the queue.
`default boolean`	`remove(java.lang.Character e)` Deprecated.
`boolean`	`removeChar(char e)` Removes the first found element in the queue
`default boolean`	`removeLast(java.lang.Character e)` Deprecated.
`boolean`	`removeLastChar(char e)` Removes the last found element in the queue
`default java.lang.Character[]`	`toArray()` Deprecated.
`java.lang.Character[]`	`toArray(java.lang.Character[] input)` Deprecated.
`default char[]`	`toCharArray()` 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

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

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

- Method Detail
  - enqueueChar
```
void enqueueChar(char e)
```
    Method to insert a element into the PriorityQueue
    
    Parameters:
    
    e - the element that should be inserted
  - dequeueChar
```
char dequeueChar()
```
    Method to extract a element from the PriorityQueue
    
    Returns:
    
    a element from the Queue
    
    Throws:
    
    java.util.NoSuchElementException - if no element is present
  - peekChar
```
char peekChar(int index)
```
    Peeking function to see whats inside the queue.
    
    Parameters:
    
    index - of the element that is requested to be viewed.
    
    Returns:
    
    the element that is requested
  - firstChar
```
default char firstChar()
```
    Shows the element that is to be returned next
    
    Returns:
    
    the first element in the Queue
  - removeChar
```
boolean removeChar(char e)
```
    Removes the first found element in the queue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - removeLastChar
```
boolean removeLastChar(char e)
```
    Removes the last found element in the queue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - onChanged
```
void onChanged()
```
    Allows to notify the Queue to be revalidate its data
    
    Specified by:
    
    onChanged in interface ObjectPriorityQueue<java.lang.Character>
  - comparator
```
CharComparator comparator()
```
    Specified by:
    
    comparator in interface ObjectPriorityQueue<java.lang.Character>
    
    Returns:
    
    the sorter of the Queue, can be null
  - toCharArray
```
default char[] toCharArray()
```
    A method to drop the contents of the Queue without clearing the queue
    
    Returns:
    
    the contents of the queue into a seperate array.
  - toCharArray
```
char[] toCharArray(char[] input)
```
    A method to drop the contents of the Queue without clearing the queue
    
    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.
    
    Note:
    
    if the Type is generic then a Object Array is created instead of a Type Array
  - enqueue
```
@Deprecated
default void enqueue(java.lang.Character e)
```
    Deprecated.
    
    Description copied from interface: ObjectPriorityQueue
    
    Method to insert a element into the PriorityQueue
    
    Specified by:
    
    enqueue in interface ObjectPriorityQueue<java.lang.Character>
    
    Parameters:
    
    e - the element that should be inserted
  - dequeue
```
@Deprecated
default java.lang.Character dequeue()
```
    Deprecated.
    
    Description copied from interface: ObjectPriorityQueue
    
    Method to extract a element from the PriorityQueue
    
    Specified by:
    
    dequeue in interface ObjectPriorityQueue<java.lang.Character>
    
    Returns:
    
    a element from the Queue
  - peek
```
@Deprecated
default java.lang.Character peek(int index)
```
    Deprecated.
    
    Description copied from interface: ObjectPriorityQueue
    
    Peeking function to see whats inside the queue.
    
    Specified by:
    
    peek in interface ObjectPriorityQueue<java.lang.Character>
    
    Parameters:
    
    index - of the element that is requested to be viewed.
    
    Returns:
    
    the element that is requested
  - first
```
@Deprecated
default java.lang.Character first()
```
    Deprecated.
    
    Description copied from interface: ObjectPriorityQueue
    
    Shows the element that is to be returned next
    
    Specified by:
    
    first in interface ObjectPriorityQueue<java.lang.Character>
    
    Returns:
    
    the first element in the Queue
  - remove
```
@Deprecated
default boolean remove(java.lang.Character e)
```
    Deprecated.
    
    Description copied from interface: ObjectPriorityQueue
    
    Removes the first found element in the queue
    
    Specified by:
    
    remove in interface ObjectPriorityQueue<java.lang.Character>
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - removeLast
```
@Deprecated
default boolean removeLast(java.lang.Character e)
```
    Deprecated.
    
    Description copied from interface: ObjectPriorityQueue
    
    Removes the last found element in the queue
    
    Specified by:
    
    removeLast in interface ObjectPriorityQueue<java.lang.Character>
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - toArray
```
@Deprecated
default java.lang.Character[] toArray()
```
    Deprecated.
    
    Description copied from interface: ObjectPriorityQueue
    
    A method to drop the contents of the Queue without clearing the queue
    
    Specified by:
    
    toArray in interface ObjectPriorityQueue<java.lang.Character>
    
    Returns:
    
    the contents of the queue into a seperate array.
  - toArray
```
@Deprecated
java.lang.Character[] toArray(java.lang.Character[] input)
```
    Deprecated.
    
    Description copied from interface: ObjectPriorityQueue
    
    A method to drop the contents of the Queue without clearing the queue
    
    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.

Interface CharPriorityQueue

Method Summary

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

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

Method Detail

enqueueChar

dequeueChar

peekChar

firstChar

removeChar

removeLastChar

onChanged

comparator

toCharArray

toCharArray

enqueue

dequeue

peek

first

remove

removeLast

toArray

toArray