speiger.src.collections.shorts.queues

Interface ShortPriorityQueue

All Superinterfaces:

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

All Known Subinterfaces:

ShortPriorityDequeue

All Known Implementing Classes:

ShortArrayFIFOQueue, ShortArrayPriorityQueue, ShortHeapPriorityQueue

public interface ShortPriorityQueue
extends ObjectPriorityQueue<java.lang.Short>, ShortIterable

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
ShortComparator	comparator()
default java.lang.Short	dequeue() Deprecated.
short	dequeueShort() Method to extract a element from the PriorityQueue
default void	enqueue(java.lang.Short e) Deprecated.
void	enqueueShort(short e) Method to insert a element into the PriorityQueue
default java.lang.Short	first() Deprecated.
default short	firstShort() Shows the element that is to be returned next
void	onChanged() Allows to notify the Queue to be revalidate its data
default java.lang.Short	peek(int index) Deprecated.
short	peekShort(int index) Peeking function to see whats inside the queue.
default boolean	remove(java.lang.Short e) Deprecated.
default boolean	removeLast(java.lang.Short e) Deprecated.
boolean	removeLastShort(short e) Removes the last found element in the queue
boolean	removeShort(short e) Removes the first found element in the queue
default java.lang.Short[]	toArray() Deprecated.
java.lang.Short[]	toArray(java.lang.Short[] input) Deprecated.
default short[]	toShortArray() A method to drop the contents of the Queue without clearing the queue
short[]	toShortArray(short[] 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.shorts.collections.ShortIterable

forEach, forEach, iterator, spliterator

Method Detail

enqueueShort

void enqueueShort(short e)

Method to insert a element into the PriorityQueue

Parameters:

e - the element that should be inserted

dequeueShort

short dequeueShort()

Method to extract a element from the PriorityQueue

Returns:

a element from the Queue

Throws:

java.util.NoSuchElementException - if no element is present

peekShort

short peekShort(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

firstShort

default short firstShort()

Shows the element that is to be returned next

Returns:

the first element in the Queue

removeShort

boolean removeShort(short e)

Removes the first found element in the queue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLastShort

boolean removeLastShort(short 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.Short>

comparator

ShortComparator comparator()

Specified by:

comparator in interface ObjectPriorityQueue<java.lang.Short>

Returns:

the sorter of the Queue, can be null

toShortArray

default short[] toShortArray()

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

Returns:

the contents of the queue into a seperate array.

toShortArray

short[] toShortArray(short[] 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.Short e)

Deprecated.

Description copied from interface: ObjectPriorityQueue

Method to insert a element into the PriorityQueue

Specified by:

enqueue in interface ObjectPriorityQueue<java.lang.Short>

Parameters:

e - the element that should be inserted

dequeue

@Deprecated
default java.lang.Short dequeue()

Deprecated.

Description copied from interface: ObjectPriorityQueue

Method to extract a element from the PriorityQueue

Specified by:

dequeue in interface ObjectPriorityQueue<java.lang.Short>

Returns:

a element from the Queue

peek

@Deprecated
default java.lang.Short 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.Short>

Parameters:

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

Returns:

the element that is requested

first

@Deprecated
default java.lang.Short first()

Deprecated.

Description copied from interface: ObjectPriorityQueue

Shows the element that is to be returned next

Specified by:

first in interface ObjectPriorityQueue<java.lang.Short>

Returns:

the first element in the Queue

remove

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

Deprecated.

Description copied from interface: ObjectPriorityQueue

Removes the first found element in the queue

Specified by:

remove in interface ObjectPriorityQueue<java.lang.Short>

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLast

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

Deprecated.

Description copied from interface: ObjectPriorityQueue

Removes the last found element in the queue

Specified by:

removeLast in interface ObjectPriorityQueue<java.lang.Short>

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

toArray

@Deprecated
default java.lang.Short[] 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.Short>

Returns:

the contents of the queue into a seperate array.

toArray

@Deprecated
java.lang.Short[] toArray(java.lang.Short[] 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.Short>

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.