ObjectPriorityQueue (Primitive-Collections 0.7.0 API)

Type Parameters:

T - the type of elements maintained by this Collection

All Superinterfaces:

java.lang.Iterable<T>, ObjectIterable<T>

All Known Subinterfaces:

ObjectPriorityDequeue<T>

All Known Implementing Classes:

AbstractObjectPriorityQueue, ObjectArrayFIFOQueue, ObjectArrayPriorityQueue, ObjectHeapPriorityQueue, ObjectLinkedList, ObjectPriorityQueues.SynchronizedPriorityDequeue, ObjectPriorityQueues.SynchronizedPriorityQueue
```
public interface ObjectPriorityQueue<T>
extends ObjectIterable<T>
```
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
`java.util.Comparator<? super T>`	`comparator()`
`ObjectPriorityQueue<T>`	`copy()` A Function that does a shallow clone of the PriorityQueue itself.
`T`	`dequeue()` Method to extract a element from the PriorityQueue
`void`	`enqueue(T e)` Method to insert a element into the PriorityQueue
`default void`	`enqueueAll(java.util.Collection<? extends T> c)` Method to mass insert elements into the PriorityQueue This method exists to add support for Java Collections to make it more useable
`default void`	`enqueueAll(ObjectCollection<T> c)` Method to mass insert elements into the PriorityQueue
`default void`	`enqueueAll(T... e)` Method to mass insert elements into the PriorityQueue
`default void`	`enqueueAll(T[] e, int length)` Method to mass insert elements into the PriorityQueue
`default void`	`enqueueAll(T[] e, int offset, int length)` Method to mass insert elements into the PriorityQueue
`default T`	`first()` Shows the element that is to be returned next
`default boolean`	`isEmpty()`
`ObjectIterator<T>`	`iterator()` Returns an iterator over elements of type `T`.
`void`	`onChanged()` Allows to notify the Queue to be revalidate its data
`T`	`peek(int index)` Peeking function to see whats inside the queue.
`boolean`	`removeFirst(T e)` Removes the first found element in the queue
`boolean`	`removeLast(T e)` Removes the last found element in the queue
`int`	`size()`
`default ObjectPriorityQueue<T>`	`synchronizeQueue()` Creates a Wrapped PriorityQueue that is Synchronized
`default ObjectPriorityQueue<T>`	`synchronizeQueue(java.lang.Object mutex)` Creates a Wrapped PriorityQueue that is Synchronized
`default <E> E[]`	`toArray()` A method to drop the contents of the Queue without clearing the queue
`<E> E[]`	`toArray(E[] input)` A method to drop the contents of the Queue without clearing the queue
`default T[]`	`toArray(Int2ObjectFunction<T[]> action)` A Helper function that simplifies the process of creating a new Array.

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

Methods inherited from interface java.lang.Iterable
forEach

- 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(T e)
```
    Method to insert a element into the PriorityQueue
    
    Parameters:
    
    e - the element that should be inserted
  - enqueueAll
```
default void enqueueAll(T... e)
```
    Method to mass insert elements into the PriorityQueue
    
    Parameters:
    
    e - the elements that should be inserted
  - enqueueAll
```
default void enqueueAll(T[] 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(T[] 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(ObjectCollection<T> c)
```
    Method to mass insert elements into the PriorityQueue
    
    Parameters:
    
    c - the elements that should be inserted from the Collection
  - enqueueAll
```
default void enqueueAll(java.util.Collection<? extends T> c)
```
    Method to mass insert elements into the PriorityQueue This method exists to add support for Java Collections to make it more useable
    
    Parameters:
    
    c - the elements that should be inserted from the Collection
  - dequeue
```
T 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
```
T 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 T first()
```
    Shows the element that is to be returned next
    
    Returns:
    
    the first element in the Queue
  - removeFirst
```
boolean removeFirst(T 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(T 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
```
ObjectPriorityQueue<T> 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
```
java.util.Comparator<? super T> comparator()
```
    Returns:
    
    the sorter of the Queue, can be null
  - iterator
```
ObjectIterator<T> iterator()
```
    Description copied from interface: ObjectIterable
    
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
    
    Specified by:
    
    iterator in interface ObjectIterable<T>
    
    Returns:
    
    draining iterator of the PriorityQueue
  - synchronizeQueue
```
default ObjectPriorityQueue<T> synchronizeQueue()
```
    Creates a Wrapped PriorityQueue that is Synchronized
    
    Returns:
    
    a new PriorityQueue that is synchronized
    
    See Also:
    
    ObjectPriorityQueues.synchronize(speiger.src.collections.objects.queues.ObjectPriorityQueue<T>)
  - synchronizeQueue
```
default ObjectPriorityQueue<T> 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:
    
    ObjectPriorityQueues.synchronize(speiger.src.collections.objects.queues.ObjectPriorityQueue<T>)
  - toArray
```
default <E> E[] toArray()
```
    A method to drop the contents of the Queue without clearing the queue
    
    Type Parameters:
    
    E - the type of elements maintained by this Collection
    
    Returns:
    
    the contents of the queue into a seperate array.
  - toArray
```
<E> E[] toArray(E[] input)
```
    A method to drop the contents of the Queue without clearing the queue
    
    Type Parameters:
    
    E - the type of elements maintained by this Collection
    
    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
  - toArray
```
default T[] toArray(Int2ObjectFunction<T[]> action)
```
    A Helper function that simplifies the process of creating a new Array.
    
    Parameters:
    
    action - the array creation function
    
    Returns:
    
    an array containing all of the elements in this collection
    
    See Also:
    
    Collection.toArray(Object[])

Interface ObjectPriorityQueue<T>

Method Summary

Methods inherited from interface speiger.src.collections.objects.collections.ObjectIterable

Methods inherited from interface java.lang.Iterable

Method Detail

isEmpty

size

clear

enqueue

enqueueAll

enqueueAll

enqueueAll

enqueueAll

enqueueAll

dequeue

peek

first

removeFirst

removeLast

onChanged

copy

comparator

iterator

synchronizeQueue

synchronizeQueue

toArray

toArray

toArray