speiger.src.collections.longs.queues

Interface LongPriorityQueue

All Superinterfaces:

java.lang.Iterable<java.lang.Long>, LongIterable, ObjectPriorityQueue<java.lang.Long>

All Known Subinterfaces:

LongPriorityDequeue

All Known Implementing Classes:

LongArrayFIFOQueue, LongArrayPriorityQueue, LongHeapPriorityQueue

public interface LongPriorityQueue
extends ObjectPriorityQueue<java.lang.Long>, LongIterable

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
LongComparator	comparator()
default java.lang.Long	dequeue() Deprecated.
long	dequeueLong() Method to extract a element from the PriorityQueue
default void	enqueue(java.lang.Long e) Deprecated.
void	enqueueLong(long e) Method to insert a element into the PriorityQueue
default java.lang.Long	first() Deprecated.
default long	firstLong() Shows the element that is to be returned next
void	onChanged() Allows to notify the Queue to be revalidate its data
default java.lang.Long	peek(int index) Deprecated.
long	peekLong(int index) Peeking function to see whats inside the queue.
default boolean	remove(java.lang.Long e) Deprecated.
default boolean	removeLast(java.lang.Long e) Deprecated.
boolean	removeLastLong(long e) Removes the last found element in the queue
boolean	removeLong(long e) Removes the first found element in the queue
default java.lang.Long[]	toArray() Deprecated.
java.lang.Long[]	toArray(java.lang.Long[] input) Deprecated.
default long[]	toLongArray() A method to drop the contents of the Queue without clearing the queue
long[]	toLongArray(long[] input) A method to drop the contents of the Queue without clearing the queue

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

clear, isEmpty, size

Methods inherited from interface speiger.src.collections.longs.collections.LongIterable

forEach, forEach, iterator, spliterator

Method Detail

enqueueLong

void enqueueLong(long e)

Method to insert a element into the PriorityQueue

Parameters:

e - the element that should be inserted

dequeueLong

long dequeueLong()

Method to extract a element from the PriorityQueue

Returns:

a element from the Queue

Throws:

java.util.NoSuchElementException - if no element is present

peekLong

long peekLong(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

firstLong

default long firstLong()

Shows the element that is to be returned next

Returns:

the first element in the Queue

removeLong

boolean removeLong(long e)

Removes the first found element in the queue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLastLong

boolean removeLastLong(long 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

Specified by:

onChanged in interface ObjectPriorityQueue<java.lang.Long>

comparator

LongComparator comparator()

Specified by:

comparator in interface ObjectPriorityQueue<java.lang.Long>

Returns:

the sorter of the Queue, can be null

toLongArray

default long[] toLongArray()

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

Returns:

the contents of the queue into a seperate array.

toLongArray

long[] toLongArray(long[] 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

enqueue

@Deprecated
default void enqueue(java.lang.Long e)

Deprecated.

Description copied from interface: ObjectPriorityQueue

Method to insert a element into the PriorityQueue

Specified by:

enqueue in interface ObjectPriorityQueue<java.lang.Long>

Parameters:

e - the element that should be inserted

dequeue

@Deprecated
default java.lang.Long dequeue()

Deprecated.

Description copied from interface: ObjectPriorityQueue

Method to extract a element from the PriorityQueue

Specified by:

dequeue in interface ObjectPriorityQueue<java.lang.Long>

Returns:

a element from the Queue

peek

@Deprecated
default java.lang.Long peek(int index)

Deprecated.

Description copied from interface: ObjectPriorityQueue

Peeking function to see whats inside the queue.

Specified by:

peek in interface ObjectPriorityQueue<java.lang.Long>

Parameters:

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

Returns:

the element that is requested

first

@Deprecated
default java.lang.Long first()

Deprecated.

Description copied from interface: ObjectPriorityQueue

Shows the element that is to be returned next

Specified by:

first in interface ObjectPriorityQueue<java.lang.Long>

Returns:

the first element in the Queue

remove

@Deprecated
default boolean remove(java.lang.Long e)

Deprecated.

Description copied from interface: ObjectPriorityQueue

Removes the first found element in the queue

Specified by:

remove in interface ObjectPriorityQueue<java.lang.Long>

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLast

@Deprecated
default boolean removeLast(java.lang.Long e)

Deprecated.

Description copied from interface: ObjectPriorityQueue

Removes the last found element in the queue

Specified by:

removeLast in interface ObjectPriorityQueue<java.lang.Long>

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

toArray

@Deprecated
default java.lang.Long[] toArray()

Deprecated.

Description copied from interface: ObjectPriorityQueue

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

Specified by:

toArray in interface ObjectPriorityQueue<java.lang.Long>

Returns:

the contents of the queue into a seperate array.

toArray

@Deprecated
java.lang.Long[] toArray(java.lang.Long[] input)

Deprecated.

Description copied from interface: ObjectPriorityQueue

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

Specified by:

toArray in interface ObjectPriorityQueue<java.lang.Long>

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.