com.ibm.bluej.util.common

Class NBest<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.PriorityQueue<T>

com.ibm.bluej.util.common.NBest<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.Queue<T>

public class NBest<T>
extends java.util.PriorityQueue<T>
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NBest(int limit) constructor that takes int limit
NBest(int limit, java.util.Comparator<T> comparator) constructor that takes limit and Comparator

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(T o) makes sure limit is not exceeded, NBest should contain the elements that are greatest
T	addRemove(T o)
java.util.List<T>	empty() removes all elements and returns them in greatest to least order
int	getLimit()

Methods inherited from class java.util.PriorityQueue

clear, comparator, contains, iterator, offer, peek, poll, remove, size, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

containsAll, equals, hashCode, isEmpty, removeAll, retainAll

Constructor Detail

NBest

public NBest(int limit)

constructor that takes int limit

Parameters:

limit -

NBest

public NBest(int limit,
     java.util.Comparator<T> comparator)

constructor that takes limit and Comparator

Parameters:

limit -

comparator -

Method Detail

getLimit

public int getLimit()

Returns:

the limit

add

public boolean add(T o)

makes sure limit is not exceeded, NBest should contain the elements that are greatest

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.Queue<T>

Overrides:

add in class java.util.PriorityQueue<T>

addRemove

public T addRemove(T o)

empty

public java.util.List<T> empty()

removes all elements and returns them in greatest to least order

Returns:

list