Modul speiger.src.collections

Package speiger.src.collections.bytes.queues

Klasse ByteArrayFIFOQueue

java.lang.Object

speiger.src.collections.bytes.queues.AbstractBytePriorityQueue

speiger.src.collections.bytes.queues.ByteArrayFIFOQueue

Alle implementierten Schnittstellen:

Iterable<Byte>, ByteIterable, BytePriorityDequeue, BytePriorityQueue, ITrimmable

public class ByteArrayFIFOQueue
extends AbstractBytePriorityQueue
implements BytePriorityDequeue, ITrimmable

A Simple First In First Out Priority Queue that is a Good Replacement for a linked list (or ArrayDequeue) Its specific implementation uses a backing array that grows and shrinks as it is needed.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final int	MIN_CAPACITY	The Minimum Capacity that is allowed

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ByteArrayFIFOQueue()	Default Construtor
ByteArrayFIFOQueue(byte[] values)	Constructor using a initial array
ByteArrayFIFOQueue(byte[] values, int size)	Constructor using a initial array
ByteArrayFIFOQueue(byte[] values, int offset, int size)	Constructor using a initial array
ByteArrayFIFOQueue(int capacity)	Constructor with a Min Capacity

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	clear()	clears all elements within the PriorityQueue, this does not resize the backing arrays
void	clearAndTrim(int size)	Trims the collection down to the requested size and clears all elements while doing so
ByteComparator	comparator()
boolean	contains(byte e)	Method to find out if a element is part of the queue
ByteArrayFIFOQueue	copy()	A Function that does a shallow clone of the PriorityQueue itself.
int	count(BytePredicate filter)	Helper function to reduce stream usage that allows to count the valid elements.
byte	dequeue()	Method to extract a element from the PriorityQueue
byte	dequeueLast()	A Method to remove a element from the last place instead of the first
void	enqueue(byte e)	Method to insert a element into the PriorityQueue
void	enqueueFirst(byte e)	Method to insert a element into the first Index instead of the last.
byte	findFirst(BytePredicate filter)	Helper function to reduce stream usage that allows to filter for the first match.
<E> void	forEach(E input, ObjectByteConsumer<E> action)	Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
void	forEach(ByteConsumer action)	A Type Specific foreach function that reduces (un)boxing
void	forEachIndexed(IntByteConsumer action)	A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
ByteIterator	iterator()	Returns an iterator over elements of type T.
boolean	matchesAll(BytePredicate filter)	Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(BytePredicate filter)	Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(BytePredicate 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
byte	peek(int index)	Peeking function to see whats inside the queue.
byte	reduce(byte identity, ByteByteUnaryOperator operator)	Performs a reduction on the elements of this Iterable
byte	reduce(ByteByteUnaryOperator operator)	Performs a reduction on the elements of this Iterable
boolean	removeFirst(byte e)	Removes the first found element in the queue
boolean	removeLast(byte e)	Removes the last found element in the queue
int	size()
byte[]	toByteArray(byte[] input)	A method to drop the contents of the Queue without clearing the queue
boolean	trim(int size)	Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Von Klasse geerbte Methoden speiger.src.collections.bytes.queues.AbstractBytePriorityQueue

equals, hashCode, toString

Von Klasse geerbte Methoden java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden speiger.src.collections.bytes.collections.ByteIterable

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

Von Schnittstelle geerbte Methoden speiger.src.collections.bytes.queues.BytePriorityDequeue

enqueueAllFirst, enqueueAllFirst, enqueueAllFirst, enqueueAllFirst, last, synchronizeQueue, synchronizeQueue

Von Schnittstelle geerbte Methoden speiger.src.collections.bytes.queues.BytePriorityQueue

enqueueAll, enqueueAll, enqueueAll, enqueueAll, first, isEmpty, toByteArray

Von Schnittstelle geerbte Methoden speiger.src.collections.utils.ITrimmable

clearAndTrim, trim

Felddetails

MIN_CAPACITY

public static final int MIN_CAPACITY

The Minimum Capacity that is allowed

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

ByteArrayFIFOQueue

public ByteArrayFIFOQueue(byte[] values)

Constructor using a initial array

Parameter:

values - the Array that should be used

ByteArrayFIFOQueue

public ByteArrayFIFOQueue(byte[] values,
 int size)

Constructor using a initial array

Parameter:

values - the Array that should be used

size - the amount of elements that are in the initial array

Löst aus:

IllegalStateException - if values is smaller then size

ByteArrayFIFOQueue

public ByteArrayFIFOQueue(byte[] values,
 int offset,
 int size)

Constructor using a initial array

Parameter:

values - the Array that should be used

offset - where to begin in the initial array

size - the amount of elements that are in the initial array

Löst aus:

IllegalStateException - if values is smaller then size

ByteArrayFIFOQueue

public ByteArrayFIFOQueue(int capacity)

Constructor with a Min Capacity

Parameter:

capacity - the initial capacity of the backing array

Löst aus:

IllegalStateException - if the initial size is smaller 0

ByteArrayFIFOQueue

public ByteArrayFIFOQueue()

Default Construtor

Methodendetails

iterator

public ByteIterator iterator()

Beschreibung aus Schnittstelle kopiert: ByteIterable

Returns an iterator over elements of type T.

Angegeben von:

iterator in Schnittstelle ByteIterable

Angegeben von:

iterator in Schnittstelle Iterable<Byte>

Gibt zurück:

an Iterator.

size

public int size()

Angegeben von:

size in Schnittstelle BytePriorityQueue

Gibt zurück:

the amount of elements that are stored in the PriorityQueue

clear

public void clear()

Beschreibung aus Schnittstelle kopiert: BytePriorityQueue

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

Angegeben von:

clear in Schnittstelle BytePriorityQueue

enqueue

public void enqueue(byte e)

Beschreibung aus Schnittstelle kopiert: BytePriorityQueue

Method to insert a element into the PriorityQueue

Angegeben von:

enqueue in Schnittstelle BytePriorityQueue

Parameter:

e - the element that should be inserted

enqueueFirst

public void enqueueFirst(byte e)

Beschreibung aus Schnittstelle kopiert: BytePriorityDequeue

Method to insert a element into the first Index instead of the last.

Angegeben von:

enqueueFirst in Schnittstelle BytePriorityDequeue

Parameter:

e - the element that should be inserted into the first place

dequeue

public byte dequeue()

Beschreibung aus Schnittstelle kopiert: BytePriorityQueue

Method to extract a element from the PriorityQueue

Angegeben von:

dequeue in Schnittstelle BytePriorityQueue

Gibt zurück:

a element from the Queue

dequeueLast

public byte dequeueLast()

Beschreibung aus Schnittstelle kopiert: BytePriorityDequeue

A Method to remove a element from the last place instead of the first

Angegeben von:

dequeueLast in Schnittstelle BytePriorityDequeue

Gibt zurück:

the last element inserted

peek

public byte peek(int index)

Beschreibung aus Schnittstelle kopiert: BytePriorityQueue

Peeking function to see whats inside the queue.

Angegeben von:

peek in Schnittstelle BytePriorityQueue

Parameter:

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

Gibt zurück:

the element that is requested

contains

public boolean contains(byte e)

Beschreibung aus Schnittstelle kopiert: BytePriorityQueue

Method to find out if a element is part of the queue

Angegeben von:

contains in Schnittstelle BytePriorityQueue

Parameter:

e - the element that is searched for

Gibt zurück:

true if the element is in the queue

removeFirst

public boolean removeFirst(byte e)

Beschreibung aus Schnittstelle kopiert: BytePriorityQueue

Removes the first found element in the queue

Angegeben von:

removeFirst in Schnittstelle BytePriorityQueue

Parameter:

e - the element that should be removed

Gibt zurück:

if a searched element was removed

removeLast

public boolean removeLast(byte e)

Beschreibung aus Schnittstelle kopiert: BytePriorityQueue

Removes the last found element in the queue

Angegeben von:

removeLast in Schnittstelle BytePriorityQueue

Parameter:

e - the element that should be removed

Gibt zurück:

if a searched element was removed

onChanged

public void onChanged()

Beschreibung aus Schnittstelle kopiert: BytePriorityQueue

Allows to notify the Queue to be revalidate its data

Angegeben von:

onChanged in Schnittstelle BytePriorityQueue

copy

public ByteArrayFIFOQueue copy()

Beschreibung aus Schnittstelle kopiert: BytePriorityQueue

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

Angegeben von:

copy in Schnittstelle BytePriorityDequeue

Angegeben von:

copy in Schnittstelle BytePriorityQueue

Gibt zurück:

a Shallow Copy of the PriorityQueue

comparator

public ByteComparator comparator()

Angegeben von:

comparator in Schnittstelle BytePriorityQueue

Gibt zurück:

the sorter of the Queue, can be null

forEach

public void forEach(ByteConsumer action)

Beschreibung aus Schnittstelle kopiert: ByteIterable

A Type Specific foreach function that reduces (un)boxing

Angegeben von:

forEach in Schnittstelle ByteIterable

Parameter:

action - The action to be performed for each element

Siehe auch:

• Iterable.forEach(Consumer)

forEachIndexed

public void forEachIndexed(IntByteConsumer action)

Beschreibung aus Schnittstelle kopiert: ByteIterable

A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.

Angegeben von:

forEachIndexed in Schnittstelle ByteIterable

Parameter:

action - The action to be performed for each element

forEach

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

Beschreibung aus Schnittstelle kopiert: ByteIterable

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

Angegeben von:

forEach in Schnittstelle ByteIterable

Typparameter:

E - the generic type of the Object

Parameter:

input - the object that should be included

action - The action to be performed for each element

matchesAny

public boolean matchesAny(BytePredicate filter)

Beschreibung aus Schnittstelle kopiert: ByteIterable

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

Angegeben von:

matchesAny in Schnittstelle ByteIterable

Parameter:

filter - that should be applied

Gibt zurück:

true if any matches were found

matchesNone

public boolean matchesNone(BytePredicate filter)

Beschreibung aus Schnittstelle kopiert: ByteIterable

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

Angegeben von:

matchesNone in Schnittstelle ByteIterable

Parameter:

filter - that should be applied

Gibt zurück:

true if no matches were found

matchesAll

public boolean matchesAll(BytePredicate filter)

Beschreibung aus Schnittstelle kopiert: ByteIterable

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

Angegeben von:

matchesAll in Schnittstelle ByteIterable

Parameter:

filter - that should be applied

Gibt zurück:

true if all matches.

findFirst

public byte findFirst(BytePredicate filter)

Beschreibung aus Schnittstelle kopiert: ByteIterable

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

Angegeben von:

findFirst in Schnittstelle ByteIterable

Parameter:

filter - that should be applied

Gibt zurück:

the found value or the null equivalent variant.

reduce

public byte reduce(byte identity,
 ByteByteUnaryOperator operator)

Beschreibung aus Schnittstelle kopiert: ByteIterable

Performs a reduction on the elements of this Iterable

Angegeben von:

reduce in Schnittstelle ByteIterable

Parameter:

identity - the start value

operator - the operation that should be applied

Gibt zurück:

the reduction result, returns identity if nothing was found

reduce

public byte reduce(ByteByteUnaryOperator operator)

Beschreibung aus Schnittstelle kopiert: ByteIterable

Performs a reduction on the elements of this Iterable

Angegeben von:

reduce in Schnittstelle ByteIterable

Parameter:

operator - the operation that should be applied

Gibt zurück:

the reduction result, returns null value if nothing was found

count

public int count(BytePredicate filter)

Beschreibung aus Schnittstelle kopiert: ByteIterable

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

Angegeben von:

count in Schnittstelle ByteIterable

Parameter:

filter - that should be applied

Gibt zurück:

the amount of Valid Elements

trim

public boolean trim(int size)

Beschreibung aus Schnittstelle kopiert: ITrimmable

Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Angegeben von:

trim in Schnittstelle ITrimmable

Parameter:

size - the requested trim size.

Gibt zurück:

if the internal array has been trimmed.

clearAndTrim

public void clearAndTrim(int size)

Trims the collection down to the requested size and clears all elements while doing so

Angegeben von:

clearAndTrim in Schnittstelle ITrimmable

Parameter:

size - the amount of elements that should be allowed

Note:

this will enforce minimum size of the collection itself

toByteArray

public byte[] toByteArray(byte[] input)

Beschreibung aus Schnittstelle kopiert: BytePriorityQueue

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

Angegeben von:

toByteArray in Schnittstelle BytePriorityQueue

Parameter:

input - where the elements should be inserted to. If it does not fit then it creates a new appropiatly created array

Gibt zurück:

the contents of the queue into a seperate array.