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

Class calitha.collections.INavigableMap


Extends calitha.collections.ISortedMap.
A SortedMap extended with navigation methods returning the closest matches for given search targets.

It is based on the Java NavigableMap interface. Differences are:


Defined in: INavigableMap.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Returns a key-value mapping associated with the least key greater than or equal to the given key, or null if there is no such key.
 
Returns the least key greater than or equal to the given key, or null if there is no such key.
 
Returns a reverse order NavigableSet view of the keys contained in this map.
 
Returns a reverse order view of the mappings contained in this map.
 
Returns a key-value mapping associated with the least key in this map, or null if the map is empty.
 
Returns a key-value mapping associated with the greatest key less than or equal to the given key, or null if there is no such key.
 
floorKey(key)
Returns the greatest key less than or equal to the given key, or null if there is no such key.
 
Returns a key-value mapping associated with the least key strictly greater than the given key, or null if there is no such key.
 
higherKey(key)
Returns the least key strictly greater than the given key, or null if there is no such key.
 
Returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
 
Returns a key-value mapping associated with the greatest key strictly less than the given key, or null if there is no such key.
 
lowerKey(key)
Returns the greatest key strictly less than the given key, or null if there is no such key.
 
Returns a NavigableSet view of the keys contained in this map.
 
Removes and returns a key-value mapping associated with the least key in this map, or null if the map is empty.
 
Removes and returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
Methods borrowed from class calitha.collections.ISortedMap:
comparator, firstKey, headMap, lastKey, subMap, tailMap
Methods borrowed from class calitha.collections.IMap:
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
Class Detail
calitha.collections.INavigableMap()
Method Detail
{calitha.collections.imap.IEntry} ceilingEntry(key)
Returns a key-value mapping associated with the least key greater than or equal to the given key, or null if there is no such key.
Parameters:
{Object} key
the key
Returns:
{calitha.collections.imap.IEntry} an entry with the least key greater than or equal to key, or null if there is no such key
Returns the least key greater than or equal to the given key, or null if there is no such key.
Parameters:
{Object} key
the key
Returns:
{calitha.collections.imap.IEntry} the least key greater than or equal to key, or null if there is no such key
{calitha.collections.INavigableSet} descendingKeySet()
Returns a reverse order NavigableSet view of the keys contained in this map.
Returns:
{calitha.collections.INavigableSet} a reverse order navigable set view of the keys in this map
Returns a reverse order view of the mappings contained in this map.
Returns:
{calitha.collections.INavigableMap} a reverse order view of this map
Returns a key-value mapping associated with the least key in this map, or null if the map is empty.
Returns:
{calitha.collections.imap.IEntry} an entry with the least key, or null if this map is empty
Returns a key-value mapping associated with the greatest key less than or equal to the given key, or null if there is no such key.
Parameters:
{Object} key
the key
Returns:
{calitha.collections.imap.IEntry} an entry with the greatest key less than or equal to key, or null if there is no such key
{Object} floorKey(key)
Returns the greatest key less than or equal to the given key, or null if there is no such key.
Parameters:
{Object} key
the key
Returns:
{Object} the greatest key less than or equal to key, or null if there is no such key
{calitha.collections.imap.IEntry} higherEntry(key)
Returns a key-value mapping associated with the least key strictly greater than the given key, or null if there is no such key.
Parameters:
{Object} key
the key
Returns:
{calitha.collections.imap.IEntry} an entry with the least key greater than key, or null if there is no such key
{Object} higherKey(key)
Returns the least key strictly greater than the given key, or null if there is no such key.
Parameters:
{Object} key
the key
Returns:
{Object} the least key greater than key, or null if there is no such key
Returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
Returns:
{calitha.collections.imap.IEntry} an entry with the greatest key, or null if this map is empty
Returns a key-value mapping associated with the greatest key strictly less than the given key, or null if there is no such key.
Parameters:
{Object} key
the key
Returns:
{calitha.collections.imap.IEntry} an entry with the greatest key less than key, or null if there is no such key
{Object} lowerKey(key)
Returns the greatest key strictly less than the given key, or null if there is no such key.
Parameters:
{Object} key
the key
Returns:
{Object} the greatest key less than key, or null if there is no such key
{calitha.collections.INavigableSet} navigableKeySet()
Returns a NavigableSet view of the keys contained in this map.
Returns:
{calitha.collections.INavigableSet} a navigable set view of the keys in this map
{calitha.collections.imap.IEntry} pollFirstEntry()
Removes and returns a key-value mapping associated with the least key in this map, or null if the map is empty.
Returns:
{calitha.collections.imap.IEntry} the removed first entry of this map, or null if this map is empty
Removes and returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
Returns:
{calitha.collections.imap.IEntry} the removed last entry of this map, or null if this map is empty