ch.awae.utils.collection.mutable

Class PriorityQueue<E>

java.lang.Object

ch.awae.utils.collection.mutable.PriorityQueue<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.Queue<E>

public class PriorityQueue<E>
extends java.lang.Object
implements java.util.Queue<E>

a priority queue implementation where each element has a defined priority. It can either be used as a min-queue or as a max-queue. In a min-queue the first element is always the one with the lowest priority value, in a max-queue it is the element with the highest priority value

Since:

awaeUtils 1.0.0

Author:

Andreas Wälchli

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PriorityQueue(boolean isMinQueue) instantiates a new priority queue

Method Summary

Modifier and Type	Method and Description
boolean	add(E e)
void	add(E element, double priority) Adds a new element with a defined priority
boolean	addAll(java.util.Collection<? extends E> c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
E	element()
boolean	isEmpty()
boolean	isMaxQueue() indicates if the queue has a max-queue configuration
boolean	isMinQueue() indicates if the queue has a min-queue configuration
java.util.Iterator<E>	iterator()
static <T> PriorityQueue<T>	maxQueue() creates a new max-priority-queue
static <T> PriorityQueue<T>	minQueue() creates a new min-priority-queue
boolean	offer(E e)
E	peek()
E	poll()
E	remove()
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
void	setPriority(E element, double priority) Sets the priority of an element in the queue
int	size()
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

PriorityQueue

protected PriorityQueue(boolean isMinQueue)

instantiates a new priority queue

Parameters:

isMinQueue - true if the queue should be a min queue, false if it should be a max queue

Method Detail

maxQueue

public static <T> PriorityQueue<T> maxQueue()

creates a new max-priority-queue

Type Parameters:

T - the type of the queue

Returns:

the created queue 1.2

minQueue

public static <T> PriorityQueue<T> minQueue()

creates a new min-priority-queue

Type Parameters:

T - the type of the queue

Returns:

the created queue 1.2

add

public boolean add(E e)

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.Queue<E>

add

public void add(E element,
                double priority)

Adds a new element with a defined priority

Parameters:

element - the element

priority - the priority

addAll

public boolean addAll(java.util.Collection<? extends E> c)

Specified by:

addAll in interface java.util.Collection<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<E>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<E>

element

public E element()

Specified by:

element in interface java.util.Queue<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<E>

isMaxQueue

public boolean isMaxQueue()

indicates if the queue has a max-queue configuration

Returns:

true iff the queue is a max-queue 1.2

isMinQueue

public boolean isMinQueue()

indicates if the queue has a min-queue configuration

Returns:

true iff the queue is a min-queue 1.2

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

offer

public boolean offer(E e)

Specified by:

offer in interface java.util.Queue<E>

peek

public E peek()

Specified by:

peek in interface java.util.Queue<E>

poll

public E poll()

Specified by:

poll in interface java.util.Queue<E>

remove

public E remove()

Specified by:

remove in interface java.util.Queue<E>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<E>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<E>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<E>

setPriority

public void setPriority(E element,
                        double priority)

Sets the priority of an element in the queue

Parameters:

element - the element to change the priority for

priority - the new priority of the element

size

public int size()

Specified by:

size in interface java.util.Collection<E>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<E>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<E>