ObjectPriorityQueues.SynchronizedPriorityQueue (Primitive-Collections 0.8.0 API)

java.lang.Object
- speiger.src.collections.objects.utils.ObjectPriorityQueues.SynchronizedPriorityQueue<T>

Type Parameters:

T - the keyType of elements maintained by this Collection

All Implemented Interfaces:

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

Direct Known Subclasses:

ObjectPriorityQueues.SynchronizedPriorityDequeue

Enclosing class:

ObjectPriorityQueues
```
public static class ObjectPriorityQueues.SynchronizedPriorityQueue<T>
extends java.lang.Object
implements ObjectPriorityQueue<T>
```
Wrapper class for synchronization

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
`java.util.Comparator<? super T>`	`comparator()`
`ObjectPriorityQueue<T>`	`copy()` A Function that does a shallow clone of the PriorityQueue itself.
`int`	`count(java.util.function.Predicate<T> filter)` Helper function to reduce stream usage that allows to count the valid elements.
`T`	`dequeue()` Method to extract a element from the PriorityQueue
`void`	`enqueue(T e)` Method to insert a element into the PriorityQueue
`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
`void`	`enqueueAll(ObjectCollection<T> c)` Method to mass insert elements into the PriorityQueue
`void`	`enqueueAll(T[] e, int offset, int length)` Method to mass insert elements into the PriorityQueue
`T`	`findFirst(java.util.function.Predicate<T> filter)` Helper function to reduce stream usage that allows to filter for the first match.
`void`	`forEach(java.util.function.Consumer<? super T> action)`
`<E> void`	`forEach(E input, ObjectObjectConsumer<E,T> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`ObjectIterator<T>`	`iterator()` Returns an iterator over elements of type `T`.
`boolean`	`matchesAll(java.util.function.Predicate<T> filter)` Helper function to reduce stream usage that allows to filter for all matches.
`boolean`	`matchesAny(java.util.function.Predicate<T> filter)` Helper function to reduce stream usage that allows to filter for any matches.
`boolean`	`matchesNone(java.util.function.Predicate<T> filter)` Helper function to reduce stream usage that allows to filter for no matches.
`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()`
`<E> E[]`	`toArray(E[] input)` A method to drop the contents of the Queue without clearing the queue

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

Methods inherited from interface speiger.src.collections.objects.queues.ObjectPriorityQueue
enqueueAll, enqueueAll, first, isEmpty, synchronizeQueue, synchronizeQueue, toArray, toArray

Methods inherited from interface speiger.src.collections.objects.collections.ObjectIterable
arrayflatMap, asAsync, distinct, filter, flatMap, forEachIndexed, limit, map, peek, pour, pourAsList, pourAsSet, reduce, reduce, repeat, sorted, spliterator

- Method Detail
  - iterator
```
public 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>
    
    Specified by:
    
    iterator in interface ObjectPriorityQueue<T>
    
    Returns:
    
    draining iterator of the PriorityQueue
  - size
```
public int size()
```
    Specified by:
    
    size in interface ObjectPriorityQueue<T>
    
    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<T>
  - enqueue
```
public void enqueue(T e)
```
    Description copied from interface: ObjectPriorityQueue
    
    Method to insert a element into the PriorityQueue
    
    Specified by:
    
    enqueue in interface ObjectPriorityQueue<T>
    
    Parameters:
    
    e - the element that should be inserted
  - enqueueAll
```
public void enqueueAll(T[] e,
                       int offset,
                       int length)
```
    Description copied from interface: ObjectPriorityQueue
    
    Method to mass insert elements into the PriorityQueue
    
    Specified by:
    
    enqueueAll in interface ObjectPriorityQueue<T>
    
    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
```
public void enqueueAll(ObjectCollection<T> c)
```
    Description copied from interface: ObjectPriorityQueue
    
    Method to mass insert elements into the PriorityQueue
    
    Specified by:
    
    enqueueAll in interface ObjectPriorityQueue<T>
    
    Parameters:
    
    c - the elements that should be inserted from the Collection
  - enqueueAll
```
public void enqueueAll(java.util.Collection<? extends T> c)
```
    Description copied from interface: ObjectPriorityQueue
    
    Method to mass insert elements into the PriorityQueue This method exists to add support for Java Collections to make it more useable
    
    Specified by:
    
    enqueueAll in interface ObjectPriorityQueue<T>
    
    Parameters:
    
    c - the elements that should be inserted from the Collection
  - dequeue
```
public T dequeue()
```
    Description copied from interface: ObjectPriorityQueue
    
    Method to extract a element from the PriorityQueue
    
    Specified by:
    
    dequeue in interface ObjectPriorityQueue<T>
    
    Returns:
    
    a element from the Queue
  - peek
```
public T peek(int index)
```
    Description copied from interface: ObjectPriorityQueue
    
    Peeking function to see whats inside the queue.
    
    Specified by:
    
    peek in interface ObjectPriorityQueue<T>
    
    Parameters:
    
    index - of the element that is requested to be viewed.
    
    Returns:
    
    the element that is requested
  - removeFirst
```
public boolean removeFirst(T e)
```
    Description copied from interface: ObjectPriorityQueue
    
    Removes the first found element in the queue
    
    Specified by:
    
    removeFirst in interface ObjectPriorityQueue<T>
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - removeLast
```
public boolean removeLast(T e)
```
    Description copied from interface: ObjectPriorityQueue
    
    Removes the last found element in the queue
    
    Specified by:
    
    removeLast in interface ObjectPriorityQueue<T>
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - onChanged
```
public void onChanged()
```
    Description copied from interface: ObjectPriorityQueue
    
    Allows to notify the Queue to be revalidate its data
    
    Specified by:
    
    onChanged in interface ObjectPriorityQueue<T>
  - comparator
```
public java.util.Comparator<? super T> comparator()
```
    Specified by:
    
    comparator in interface ObjectPriorityQueue<T>
    
    Returns:
    
    the sorter of the Queue, can be null
  - toArray
```
public <E> E[] toArray(E[] input)
```
    Description copied from interface: ObjectPriorityQueue
    
    A method to drop the contents of the Queue without clearing the queue
    
    Specified by:
    
    toArray in interface ObjectPriorityQueue<T>
    
    Type Parameters:
    
    E - the keyType 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.
  - copy
```
public ObjectPriorityQueue<T> copy()
```
    Description copied from interface: ObjectPriorityQueue
    
    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
    
    Specified by:
    
    copy in interface ObjectPriorityQueue<T>
    
    Returns:
    
    a Shallow Copy of the PriorityQueue
  - forEach
```
public void forEach(java.util.function.Consumer<? super T> action)
```
    Specified by:
    
    forEach in interface java.lang.Iterable<T>
  - forEach
```
public <E> void forEach(E input,
                        ObjectObjectConsumer<E,T> action)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
    
    Specified by:
    
    forEach in interface ObjectIterable<T>
    
    Type Parameters:
    
    E - the generic type of the Object
    
    Parameters:
    
    input - the object that should be included
    
    action - The action to be performed for each element
  - matchesAny
```
public boolean matchesAny(java.util.function.Predicate<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for any matches.
    
    Specified by:
    
    matchesAny in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if any matches were found
  - matchesNone
```
public boolean matchesNone(java.util.function.Predicate<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for no matches.
    
    Specified by:
    
    matchesNone in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if no matches were found
  - matchesAll
```
public boolean matchesAll(java.util.function.Predicate<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for all matches.
    
    Specified by:
    
    matchesAll in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if all matches.
  - findFirst
```
public T findFirst(java.util.function.Predicate<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for the first match.
    
    Specified by:
    
    findFirst in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the found value or the null equivalent variant.
  - count
```
public int count(java.util.function.Predicate<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to count the valid elements.
    
    Specified by:
    
    count in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements

Class ObjectPriorityQueues.SynchronizedPriorityQueue<T>

Method Summary

Methods inherited from class java.lang.Object

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

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

Method Detail

iterator

size

clear

enqueue

enqueueAll

enqueueAll

enqueueAll

dequeue

peek

removeFirst

removeLast

onChanged

comparator

toArray

copy

forEach

forEach

matchesAny

matchesNone

matchesAll

findFirst

count