speiger.src.collections.objects.queues

Interface ObjectPriorityQueue<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Superinterfaces:

java.lang.Iterable<T>

All Known Subinterfaces:

BooleanPriorityDequeue, BooleanPriorityQueue, BytePriorityDequeue, BytePriorityQueue, CharPriorityDequeue, CharPriorityQueue, DoublePriorityDequeue, DoublePriorityQueue, FloatPriorityDequeue, FloatPriorityQueue, IntPriorityDequeue, IntPriorityQueue, LongPriorityDequeue, LongPriorityQueue, ObjectPriorityDequeue<T>, ShortPriorityDequeue, ShortPriorityQueue

All Known Implementing Classes:

BooleanArrayFIFOQueue, BooleanArrayPriorityQueue, BooleanHeapPriorityQueue, ByteArrayFIFOQueue, ByteArrayPriorityQueue, ByteHeapPriorityQueue, CharArrayFIFOQueue, CharArrayPriorityQueue, CharHeapPriorityQueue, DoubleArrayFIFOQueue, DoubleArrayPriorityQueue, DoubleHeapPriorityQueue, FloatArrayFIFOQueue, FloatArrayPriorityQueue, FloatHeapPriorityQueue, IntArrayFIFOQueue, IntArrayPriorityQueue, IntHeapPriorityQueue, LongArrayFIFOQueue, LongArrayPriorityQueue, LongHeapPriorityQueue, ObjectArrayFIFOQueue, ObjectArrayPriorityQueue, ObjectHeapPriorityQueue, ShortArrayFIFOQueue, ShortArrayPriorityQueue, ShortHeapPriorityQueue

public interface ObjectPriorityQueue<T>
extends java.lang.Iterable<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

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()
T	dequeue() Method to extract a element from the PriorityQueue
void	enqueue(T e) Method to insert a element into the PriorityQueue
default T	first() Shows the element that is to be returned next
default boolean	isEmpty()
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	remove(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 T[]	toArray() A method to drop the contents of the Queue without clearing the queue
T[]	toArray(T[] input) A method to drop the contents of the Queue without clearing the queue

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

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

remove

boolean remove(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

comparator

java.util.Comparator<? super T> comparator()

Returns:

the sorter of the Queue, can be null

toArray

default T[] toArray()

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

Returns:

the contents of the queue into a seperate array.

toArray

T[] toArray(T[] input)

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

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