soot.util

Class PriorityQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

soot.util.PriorityQueue<E>

Type Parameters:

E - the type of elements held in the universe

All Implemented Interfaces:

Iterable<E>, Collection<E>, Queue<E>

public abstract class PriorityQueue<E>
extends AbstractQueue<E>

A fixed size priority queue based on bitsets. The elements of the priority queue are ordered according to a given universe. This priority queue does not permit null elements. Inserting of elements that are not part of the universe is also permitted (doing so will result in a NoSuchElementException).

Author:

Steven Lambeth

Method Summary

Modifier and Type	Method and Description
boolean	add(E e)
boolean	contains(Object o)
boolean	isEmpty()
static <E> PriorityQueue<E>	noneOf(E[] universe) Creates a new empty priority queue
static <E> PriorityQueue<E>	noneOf(List<? extends E> universe) Creates a new empty priority queue
static <E extends Numberable> PriorityQueue<E>	noneOf(List<? extends E> universe, boolean useNumberInterface)
static <E> PriorityQueue<E>	of(E[] universe) Creates a new full priority queue
static <E> PriorityQueue<E>	of(List<? extends E> universe) Creates a new full priority queue
static <E extends Numberable> PriorityQueue<E>	of(List<? extends E> universe, boolean useNumberInterface)
boolean	offer(E e)
E	peek()
E	poll()
boolean	remove(Object o)

Methods inherited from class java.util.AbstractQueue

addAll, clear, element, remove

Methods inherited from class java.util.AbstractCollection

containsAll, iterator, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

containsAll, equals, hashCode, iterator, parallelStream, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

peek

public final E peek()

poll

public final E poll()

add

public final boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Queue<E>

Overrides:

add in class AbstractQueue<E>

Throws:

NoSuchElementException - if e not part of the universe

NullPointerException - if e is null

offer

public final boolean offer(E e)

Throws:

NoSuchElementException - if e not part of the universe

NullPointerException - if e is null

remove

public final boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Overrides:

remove in class AbstractCollection<E>

contains

public final boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Overrides:

contains in class AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Overrides:

isEmpty in class AbstractCollection<E>

of

public static <E> PriorityQueue<E> of(E[] universe)

Creates a new full priority queue

Parameters:

universe -

Returns:

noneOf

public static <E> PriorityQueue<E> noneOf(E[] universe)

Creates a new empty priority queue

Parameters:

universe -

Returns:

of

public static <E> PriorityQueue<E> of(List<? extends E> universe)

Creates a new full priority queue

Parameters:

universe -

Returns:

noneOf

public static <E> PriorityQueue<E> noneOf(List<? extends E> universe)

Creates a new empty priority queue

Parameters:

universe -

Returns:

of

public static <E extends Numberable> PriorityQueue<E> of(List<? extends E> universe,
                                                         boolean useNumberInterface)

noneOf

public static <E extends Numberable> PriorityQueue<E> noneOf(List<? extends E> universe,
                                                             boolean useNumberInterface)