info.debatty.java.util

Class BoundedPriorityQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.PriorityQueue<E>

info.debatty.java.util.BoundedPriorityQueue<E>

Type Parameters:

E -

All Implemented Interfaces:

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

public class BoundedPriorityQueue<E>
extends PriorityQueue<E>
implements Serializable

This class implements a bounded priority queue A structure that always keeps the n 'largest' elements.

Author:

Thibault Debatty

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BoundedPriorityQueue() Creates a priority queue with maximum capacity Integer.MAX_VALUE.
BoundedPriorityQueue(int capacity) Create a bounded priority queue with given maximum capacity.

Method Summary

Modifier and Type	Method and Description
boolean	add(E element) When the queue is full, adds the element if it is larger than the smallest element already in the queue.
boolean	equals(Object other)
int	getCapacity()
int	hashCode()

Methods inherited from class java.util.PriorityQueue

clear, comparator, contains, iterator, offer, peek, poll, remove, size, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractQueue

addAll, element, remove

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

containsAll, isEmpty, parallelStream, removeAll, removeIf, retainAll, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

BoundedPriorityQueue

public BoundedPriorityQueue(int capacity)

Create a bounded priority queue with given maximum capacity.

Parameters:

capacity - The maximum capacity of the queue

BoundedPriorityQueue

public BoundedPriorityQueue()

Creates a priority queue with maximum capacity Integer.MAX_VALUE.

Method Detail

add

public final boolean add(E element)

When the queue is full, adds the element if it is larger than the smallest element already in the queue. It the element is not comparable, throws a ClassCastException

Specified by:

add in interface Collection<E>

Specified by:

add in interface Queue<E>

Overrides:

add in class PriorityQueue<E>

Parameters:

element -

Returns:

true if element was added

getCapacity

public final int getCapacity()

Returns:

equals

public final boolean equals(Object other)

Specified by:

equals in interface Collection<E>

Overrides:

equals in class Object

Parameters:

other -

Returns:

hashCode

public final int hashCode()

Specified by:

hashCode in interface Collection<E>

Overrides:

hashCode in class Object