Generated by JsDoc Toolkit 2.3.2 on Sun Jun 13 2010 17:28:18 GMT+0200 (CEST)
HTML template: Codeview

Class calitha.collections.INavigableSet


Extends calitha.collections.ISortedSet.
A SortedSet extended with navigation methods reporting closest matches for given search targets.

It is based on the Java NavigableSet interface.
Defined in: INavigableSet.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Returns the least element in this set greater than or equal to the given element, or null if there is no such element.
 
Returns an iterator over the elements in this set, in descending order.
 
Returns a reverse order view of the elements contained in this set.
 
floor(e)
Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.
 
higher(e)
Returns the least element in this set strictly greater than the given element, or null if there is no such element.
 
Returns an iterator over the elements in this set, in ascending order.
 
lower(e)
Returns the greatest element in this set strictly less than the given element, or null if there is no such element.
 
Retrieves and removes the first (lowest) element, or returns null if this set is empty.
 
Retrieves and removes the last (highest) element, or returns null if this set is empty.
Methods borrowed from class calitha.collections.ISortedSet:
comparator, first, headSet, last, subSet, tailSet
Methods borrowed from class calitha.collections.ICollection:
add, addAll, clear, contains, containsAll, equals, forEach, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray
Class Detail
calitha.collections.INavigableSet()
Method Detail
{Object} ceiling(e)
Returns the least element in this set greater than or equal to the given element, or null if there is no such element.
Parameters:
{Object} e
the value to match
Returns:
{Object} the least element greater than or equal to e, or null if there is no such element
{calitha.collections.IIterator} descendingIterator()
Returns an iterator over the elements in this set, in descending order.
Returns:
{calitha.collections.IIterator} an iterator over the elements in this set, in descending order
Returns a reverse order view of the elements contained in this set.
Returns:
{calitha.collections.INavigableSet} a reverse order view of this set
{Object} floor(e)
Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.
Parameters:
{Object} e
the value to match
Returns:
{Object} the greatest element less than or equal to e, or null if there is no such element
{Object} higher(e)
Returns the least element in this set strictly greater than the given element, or null if there is no such element.
Parameters:
{Object} e
the value to match
Returns:
{Object} the least element greater than e, or null if there is no such element
Returns an iterator over the elements in this set, in ascending order.
Returns:
{calitha.collections.IIterator} an iterator over the elements in this set, in ascending order
{Object} lower(e)
Returns the greatest element in this set strictly less than the given element, or null if there is no such element.
Parameters:
{Object} e
the value to match
Returns:
{Object} the greatest element less than e, or null if there is no such element
{Object} pollFirst()
Retrieves and removes the first (lowest) element, or returns null if this set is empty.
Returns:
{Object} the first element, or null if this set is empty
{Object} pollLast()
Retrieves and removes the last (highest) element, or returns null if this set is empty.
Returns:
{Object} the last element, or null if this set is empty