ShortPriorityQueues.SynchronizedPriorityQueue (Primitive-Collections 0.7.0 API)

java.lang.Object
- speiger.src.collections.shorts.utils.ShortPriorityQueues.SynchronizedPriorityQueue

All Implemented Interfaces:

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

Direct Known Subclasses:

ShortPriorityQueues.SynchronizedPriorityDequeue

Enclosing class:

ShortPriorityQueues
```
public static class ShortPriorityQueues.SynchronizedPriorityQueue
extends java.lang.Object
implements ShortPriorityQueue
```
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
`ShortComparator`	`comparator()`
`ShortPriorityQueue`	`copy()` A Function that does a shallow clone of the PriorityQueue itself.
`int`	`count(Short2BooleanFunction filter)` Helper function to reduce stream usage that allows to count the valid elements.
`short`	`dequeue()` Method to extract a element from the PriorityQueue
`void`	`enqueue(short e)` Method to insert a element into the PriorityQueue
`void`	`enqueueAll(short[] e, int offset, int length)` Method to mass insert elements into the PriorityQueue
`void`	`enqueueAll(ShortCollection c)` Method to mass insert elements into the PriorityQueue
`short`	`findFirst(Short2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for the first match.
`<E> void`	`forEach(E input, ObjectShortConsumer<E> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`void`	`forEach(ShortConsumer action)` A Type Specific foreach function that reduces (un)boxing
`ShortIterator`	`iterator()` Returns an iterator over elements of type `T`.
`boolean`	`matchesAll(Short2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for all matches.
`boolean`	`matchesAny(Short2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for any matches.
`boolean`	`matchesNone(Short2BooleanFunction 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
`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()`
`short[]`	`toShortArray(short[] 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.shorts.queues.ShortPriorityQueue
enqueueAll, enqueueAll, first, isEmpty, synchronizeQueue, synchronizeQueue, toShortArray

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

- Method Detail
  - iterator
```
public ShortIterator iterator()
```
    Description copied from interface: ShortIterable
    
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Short>
    
    Specified by:
    
    iterator in interface ShortIterable
    
    Returns:
    
    an Iterator.
  - size
```
public int size()
```
    Specified by:
    
    size in interface ShortPriorityQueue
    
    Returns:
    
    the amount of elements that are stored in the PriorityQueue
  - clear
```
public void clear()
```
    Description copied from interface: ShortPriorityQueue
    
    clears all elements within the PriorityQueue, this does not resize the backing arrays
    
    Specified by:
    
    clear in interface ShortPriorityQueue
  - enqueue
```
public void enqueue(short e)
```
    Description copied from interface: ShortPriorityQueue
    
    Method to insert a element into the PriorityQueue
    
    Specified by:
    
    enqueue in interface ShortPriorityQueue
    
    Parameters:
    
    e - the element that should be inserted
  - enqueueAll
```
public void enqueueAll(short[] e,
                       int offset,
                       int length)
```
    Description copied from interface: ShortPriorityQueue
    
    Method to mass insert elements into the PriorityQueue
    
    Specified by:
    
    enqueueAll in interface ShortPriorityQueue
    
    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(ShortCollection c)
```
    Description copied from interface: ShortPriorityQueue
    
    Method to mass insert elements into the PriorityQueue
    
    Specified by:
    
    enqueueAll in interface ShortPriorityQueue
    
    Parameters:
    
    c - the elements that should be inserted from the Collection
  - dequeue
```
public short dequeue()
```
    Description copied from interface: ShortPriorityQueue
    
    Method to extract a element from the PriorityQueue
    
    Specified by:
    
    dequeue in interface ShortPriorityQueue
    
    Returns:
    
    a element from the Queue
  - peek
```
public short peek(int index)
```
    Description copied from interface: ShortPriorityQueue
    
    Peeking function to see whats inside the queue.
    
    Specified by:
    
    peek in interface ShortPriorityQueue
    
    Parameters:
    
    index - of the element that is requested to be viewed.
    
    Returns:
    
    the element that is requested
  - removeFirst
```
public boolean removeFirst(short e)
```
    Description copied from interface: ShortPriorityQueue
    
    Removes the first found element in the queue
    
    Specified by:
    
    removeFirst in interface ShortPriorityQueue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - removeLast
```
public boolean removeLast(short e)
```
    Description copied from interface: ShortPriorityQueue
    
    Removes the last found element in the queue
    
    Specified by:
    
    removeLast in interface ShortPriorityQueue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - onChanged
```
public void onChanged()
```
    Description copied from interface: ShortPriorityQueue
    
    Allows to notify the Queue to be revalidate its data
    
    Specified by:
    
    onChanged in interface ShortPriorityQueue
  - comparator
```
public ShortComparator comparator()
```
    Specified by:
    
    comparator in interface ShortPriorityQueue
    
    Returns:
    
    the sorter of the Queue, can be null
  - toShortArray
```
public short[] toShortArray(short[] input)
```
    Description copied from interface: ShortPriorityQueue
    
    A method to drop the contents of the Queue without clearing the queue
    
    Specified by:
    
    toShortArray in interface ShortPriorityQueue
    
    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 ShortPriorityQueue copy()
```
    Description copied from interface: ShortPriorityQueue
    
    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 ShortPriorityQueue
    
    Returns:
    
    a Shallow Copy of the PriorityQueue
  - forEach
```
public void forEach(ShortConsumer action)
```
    Description copied from interface: ShortIterable
    
    A Type Specific foreach function that reduces (un)boxing
    
    Specified by:
    
    forEach in interface ShortIterable
    
    Parameters:
    
    action - The action to be performed for each element
    
    See Also:
    
    Iterable.forEach(Consumer)
  - forEach
```
public <E> void forEach(E input,
                        ObjectShortConsumer<E> action)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
    
    Specified by:
    
    forEach in interface ShortIterable
    
    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(Short2BooleanFunction filter)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce stream usage that allows to filter for any matches.
    
    Specified by:
    
    matchesAny in interface ShortIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if any matches were found
  - matchesNone
```
public boolean matchesNone(Short2BooleanFunction filter)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce stream usage that allows to filter for no matches.
    
    Specified by:
    
    matchesNone in interface ShortIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if no matches were found
  - matchesAll
```
public boolean matchesAll(Short2BooleanFunction filter)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce stream usage that allows to filter for all matches.
    
    Specified by:
    
    matchesAll in interface ShortIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if all matches.
  - findFirst
```
public short findFirst(Short2BooleanFunction filter)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce stream usage that allows to filter for the first match.
    
    Specified by:
    
    findFirst in interface ShortIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the found value or the null equivalent variant.
  - count
```
public int count(Short2BooleanFunction filter)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce stream usage that allows to count the valid elements.
    
    Specified by:
    
    count in interface ShortIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements

Class ShortPriorityQueues.SynchronizedPriorityQueue

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.shorts.queues.ShortPriorityQueue

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

Method Detail

iterator

size

clear

enqueue

enqueueAll

enqueueAll

dequeue

peek

removeFirst

removeLast

onChanged

comparator

toShortArray

copy

forEach

forEach

matchesAny

matchesNone

matchesAll

findFirst

count