speiger.src.collections.booleans.utils

Class BooleanPriorityQueues.SynchronizedPriorityQueue

java.lang.Object

speiger.src.collections.booleans.utils.BooleanPriorityQueues.SynchronizedPriorityQueue

All Implemented Interfaces:

java.lang.Iterable<java.lang.Boolean>, BooleanIterable, BooleanPriorityQueue

Direct Known Subclasses:

BooleanPriorityQueues.SynchronizedPriorityDequeue

Enclosing class:

BooleanPriorityQueues

public static class BooleanPriorityQueues.SynchronizedPriorityQueue
extends java.lang.Object
implements BooleanPriorityQueue

Wrapper class for synchronization

Method Summary

Modifier and Type	Method and Description
void	clear() clears all elements within the PriorityQueue, this does not resize the backing arrays
BooleanComparator	comparator()
BooleanPriorityQueue	copy() A Function that does a shallow clone of the PriorityQueue itself.
int	count(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to count the valid elements.
boolean	dequeue() Method to extract a element from the PriorityQueue
void	enqueue(boolean e) Method to insert a element into the PriorityQueue
void	enqueueAll(boolean[] e, int offset, int length) Method to mass insert elements into the PriorityQueue
void	enqueueAll(BooleanCollection c) Method to mass insert elements into the PriorityQueue
boolean	findFirst(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for the first match.
void	forEach(BooleanConsumer action) A Type Specific foreach function that reduces (un)boxing
<E> void	forEach(E input, ObjectBooleanConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
BooleanIterator	iterator() Returns an iterator over elements of type T.
boolean	matchesAll(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(Boolean2BooleanFunction 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
boolean	peek(int index) Peeking function to see whats inside the queue.
boolean	removeFirst(boolean e) Removes the first found element in the queue
boolean	removeLast(boolean e) Removes the last found element in the queue
int	size()
boolean[]	toBooleanArray(boolean[] 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.booleans.queues.BooleanPriorityQueue

enqueueAll, enqueueAll, first, isEmpty, synchronizeQueue, synchronizeQueue, toBooleanArray

Methods inherited from interface speiger.src.collections.booleans.collections.BooleanIterable

arrayflatMap, asAsync, distinct, filter, flatMap, forEach, limit, map, peek, pour, pourAsList, reduce, reduce, sorted, spliterator

Method Detail

iterator

public BooleanIterator iterator()

Description copied from interface: BooleanIterable

Returns an iterator over elements of type T.

Specified by:

iterator in interface java.lang.Iterable<java.lang.Boolean>

Specified by:

iterator in interface BooleanIterable

Returns:

an Iterator.

size

public int size()

Specified by:

size in interface BooleanPriorityQueue

Returns:

the amount of elements that are stored in the PriorityQueue

clear

public void clear()

Description copied from interface: BooleanPriorityQueue

clears all elements within the PriorityQueue, this does not resize the backing arrays

Specified by:

clear in interface BooleanPriorityQueue

enqueue

public void enqueue(boolean e)

Description copied from interface: BooleanPriorityQueue

Method to insert a element into the PriorityQueue

Specified by:

enqueue in interface BooleanPriorityQueue

Parameters:

e - the element that should be inserted

enqueueAll

public void enqueueAll(boolean[] e,
                       int offset,
                       int length)

Description copied from interface: BooleanPriorityQueue

Method to mass insert elements into the PriorityQueue

Specified by:

enqueueAll in interface BooleanPriorityQueue

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(BooleanCollection c)

Description copied from interface: BooleanPriorityQueue

Method to mass insert elements into the PriorityQueue

Specified by:

enqueueAll in interface BooleanPriorityQueue

Parameters:

c - the elements that should be inserted from the Collection

dequeue

public boolean dequeue()

Description copied from interface: BooleanPriorityQueue

Method to extract a element from the PriorityQueue

Specified by:

dequeue in interface BooleanPriorityQueue

Returns:

a element from the Queue

peek

public boolean peek(int index)

Description copied from interface: BooleanPriorityQueue

Peeking function to see whats inside the queue.

Specified by:

peek in interface BooleanPriorityQueue

Parameters:

index - of the element that is requested to be viewed.

Returns:

the element that is requested

removeFirst

public boolean removeFirst(boolean e)

Description copied from interface: BooleanPriorityQueue

Removes the first found element in the queue

Specified by:

removeFirst in interface BooleanPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLast

public boolean removeLast(boolean e)

Description copied from interface: BooleanPriorityQueue

Removes the last found element in the queue

Specified by:

removeLast in interface BooleanPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

onChanged

public void onChanged()

Description copied from interface: BooleanPriorityQueue

Allows to notify the Queue to be revalidate its data

Specified by:

onChanged in interface BooleanPriorityQueue

comparator

public BooleanComparator comparator()

Specified by:

comparator in interface BooleanPriorityQueue

Returns:

the sorter of the Queue, can be null

toBooleanArray

public boolean[] toBooleanArray(boolean[] input)

Description copied from interface: BooleanPriorityQueue

A method to drop the contents of the Queue without clearing the queue

Specified by:

toBooleanArray in interface BooleanPriorityQueue

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 BooleanPriorityQueue copy()

Description copied from interface: BooleanPriorityQueue

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 BooleanPriorityQueue

Returns:

a Shallow Copy of the PriorityQueue

forEach

public void forEach(BooleanConsumer action)

Description copied from interface: BooleanIterable

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface BooleanIterable

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

forEach

public <E> void forEach(E input,
                        ObjectBooleanConsumer<E> action)

Description copied from interface: BooleanIterable

Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.

Specified by:

forEach in interface BooleanIterable

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(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for any matches.

Specified by:

matchesAny in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for no matches.

Specified by:

matchesNone in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for all matches.

Specified by:

matchesAll in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

true if all matches.

findFirst

public boolean findFirst(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for the first match.

Specified by:

findFirst in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

count

public int count(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to count the valid elements.

Specified by:

count in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements