ShortPriorityQueue (Primitive-Collections 0.7.0 API)

All Superinterfaces:

java.lang.Iterable<java.lang.Short>, ShortIterable

All Known Subinterfaces:

ShortPriorityDequeue

All Known Implementing Classes:

AbstractShortPriorityQueue, ShortArrayFIFOQueue, ShortArrayPriorityQueue, ShortHeapPriorityQueue, ShortLinkedList, ShortPriorityQueues.SynchronizedPriorityDequeue, ShortPriorityQueues.SynchronizedPriorityQueue
```
public interface ShortPriorityQueue
extends ShortIterable
```
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
Modifier and Type	Method and Description
`void`	`clear()` clears all elements within the PriorityQueue, this does not resize the backing arrays
`ShortComparator`	`comparator()`
`ShortPriorityQueue`	`copy()` A Function that does a shallow clone of the PriorityQueue itself.
`short`	`dequeue()` Method to extract a element from the PriorityQueue
`void`	`enqueue(short e)` Method to insert a element into the PriorityQueue
`default void`	`enqueueAll(short... e)` Method to mass insert elements into the PriorityQueue
`default void`	`enqueueAll(short[] e, int length)` Method to mass insert elements into the PriorityQueue
`default void`	`enqueueAll(short[] e, int offset, int length)` Method to mass insert elements into the PriorityQueue
`default void`	`enqueueAll(ShortCollection c)` Method to mass insert elements into the PriorityQueue
`default short`	`first()` Shows the element that is to be returned next
`default boolean`	`isEmpty()`
`void`	`onChanged()` Allows to notify the Queue to be revalidate its data
`short`	`peek(int index)` Peeking function to see whats inside the queue.
`boolean`	`removeFirst(short e)` Removes the first found element in the queue
`boolean`	`removeLast(short e)` Removes the last found element in the queue
`int`	`size()`
`default ShortPriorityQueue`	`synchronizeQueue()` Creates a Wrapped PriorityQueue that is Synchronized
`default ShortPriorityQueue`	`synchronizeQueue(java.lang.Object mutex)` Creates a Wrapped PriorityQueue that is Synchronized
`default short[]`	`toShortArray()` A method to drop the contents of the Queue without clearing the queue
`short[]`	`toShortArray(short[] input)` A method to drop the contents of the Queue without clearing the queue

Methods inherited from interface speiger.src.collections.shorts.collections.ShortIterable
arrayflatMap, asAsync, count, distinct, filter, findFirst, flatMap, forEach, forEach, forEach, iterator, limit, map, matchesAll, matchesAny, matchesNone, peek, pour, pourAsList, pourAsSet, reduce, reduce, sorted, spliterator

- Method Detail
  - isEmpty
```
default boolean isEmpty()
```
    Returns:
    
    true if the PriorityQueue is empty
  - size
```
int size()
```
    Returns:
    
    the amount of elements that are stored in the PriorityQueue
  - clear
```
void clear()
```
    clears all elements within the PriorityQueue, this does not resize the backing arrays
  - enqueue
```
void enqueue(short e)
```
    Method to insert a element into the PriorityQueue
    
    Parameters:
    
    e - the element that should be inserted
  - enqueueAll
```
default void enqueueAll(short... e)
```
    Method to mass insert elements into the PriorityQueue
    
    Parameters:
    
    e - the elements that should be inserted
  - enqueueAll
```
default void enqueueAll(short[] e,
                        int length)
```
    Method to mass insert elements into the PriorityQueue
    
    Parameters:
    
    e - the elements that should be inserted
    
    length - the amount of elements that should be inserted
  - enqueueAll
```
default void enqueueAll(short[] e,
                        int offset,
                        int length)
```
    Method to mass insert elements into the PriorityQueue
    
    Parameters:
    
    e - the elements that should be inserted
    
    offset - the offset where in the array should be started
    
    length - the amount of elements that should be inserted
  - enqueueAll
```
default void enqueueAll(ShortCollection c)
```
    Method to mass insert elements into the PriorityQueue
    
    Parameters:
    
    c - the elements that should be inserted from the Collection
  - dequeue
```
short dequeue()
```
    Method to extract a element from the PriorityQueue
    
    Returns:
    
    a element from the Queue
    
    Throws:
    
    java.util.NoSuchElementException - if no element is present
  - peek
```
short peek(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
  - first
```
default short first()
```
    Shows the element that is to be returned next
    
    Returns:
    
    the first element in the Queue
  - removeFirst
```
boolean removeFirst(short e)
```
    Removes the first found element in the queue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - removeLast
```
boolean removeLast(short 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
  - copy
```
ShortPriorityQueue copy()
```
    A Function that does a shallow clone of the PriorityQueue itself. This function is more optimized then a copy constructor since the PriorityQueue does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Returns:
    
    a Shallow Copy of the PriorityQueue
    
    Note:
    
    Wrappers and view PriorityQueues will not support this feature
  - comparator
```
ShortComparator comparator()
```
    Returns:
    
    the sorter of the Queue, can be null
  - synchronizeQueue
```
default ShortPriorityQueue synchronizeQueue()
```
    Creates a Wrapped PriorityQueue that is Synchronized
    
    Returns:
    
    a new PriorityQueue that is synchronized
    
    See Also:
    
    ShortPriorityQueues.synchronize(speiger.src.collections.shorts.queues.ShortPriorityQueue)
  - synchronizeQueue
```
default ShortPriorityQueue synchronizeQueue(java.lang.Object mutex)
```
    Creates a Wrapped PriorityQueue that is Synchronized
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new PriorityQueue Wrapper that is synchronized
    
    See Also:
    
    ShortPriorityQueues.synchronize(speiger.src.collections.shorts.queues.ShortPriorityQueue)
  - toShortArray
```
default short[] toShortArray()
```
    A method to drop the contents of the Queue without clearing the queue
    
    Returns:
    
    the contents of the queue into a seperate array.
  - toShortArray
```
short[] toShortArray(short[] 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

Interface ShortPriorityQueue

Method Summary

Methods inherited from interface speiger.src.collections.shorts.collections.ShortIterable

Method Detail

isEmpty

size

clear

enqueue

enqueueAll

enqueueAll

enqueueAll

enqueueAll

dequeue

peek

first

removeFirst

removeLast

onChanged

copy

comparator

synchronizeQueue

synchronizeQueue

toShortArray

toShortArray