| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectInputStream in = …;
NavigableMap r = (NavigableMap)in.readObject();
Based on 10 examples
public interface NavigableMap extends SortedMap
A {@link SortedMap} extended with navigation methods returning the closest matches for given search targets. Methods {@code lowerEntry}, {@code floorEntry}, {@code ceilingEntry}, and {@code higherEntry} return {@code Map.Entry} objects associated with keys respectively less than, less than or equal, greater than or equal, and greater than a given key, returning {@code null} if there is no such key. Similarly, methods {@code lowerKey}, {@code floorKey}, {@code ceilingKey}, and {@code higherKey} return only the associated keys. All of these methods are designed for locating, not traversing entries.
A {@code NavigableMap} may be accessed and traversed in either ascending or descending key order. The {@code descendingMap} method returns a view of the map with the senses of all relational and directional methods inverted. The performance of ascending operations and views is likely to be faster than that of descending ones. Methods {@code subMap}, {@code headMap}, and {@code tailMap} differ from the like-named {@code SortedMap} methods in accepting additional arguments describing whether lower and upper bounds are inclusive versus exclusive. Submaps of any {@code NavigableMap} must implement the {@code NavigableMap} interface.
This interface additionally defines methods {@code firstEntry}, {@code pollFirstEntry}, {@code lastEntry}, and {@code pollLastEntry} that return and/or remove the least and greatest mappings, if any exist, else returning {@code null}.
Implementations of entry-returning methods are expected to return {@code Map.Entry} pairs representing snapshots of mappings at the time they were produced, and thus generally do not support the optional {@code Entry.setValue} method. Note however that it is possible to change mappings in the associated map using method {@code put}.
Methods {@link #subMap(Object, Object) subMap(K, K)}, {@link #headMap(Object) headMap(K)}, and {@link #tailMap(Object) tailMap(K)} are specified to return {@code SortedMap} to allow existing implementations of {@code SortedMap} to be compatibly retrofitted to implement {@code NavigableMap}, but extensions and implementations of this interface are encouraged to override these methods to return {@code NavigableMap}. Similarly, {@link #keySet()} can be overriden to return {@code NavigableSet}.
This interface is a member of the Java Collections Framework.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.util.Map |
---|
Map.Entry |
Method Summary | |
---|---|
Map.Entry |
ceilingEntry(Object key) Returns a key-value mapping associated with the least key greater than or equal to the given key, or if there is no such key. |
Object |
ceilingKey(Object key) Returns the least key greater than or equal to the given key, or if there is no such key. |
NavigableSet |
Returns a reverse order java.util.NavigableSet view of the keys contained in this map. |
NavigableMap |
Returns a reverse order view of the mappings contained in this map. |
Map.Entry |
Returns a key-value mapping associated with the least key in this map, or if the map is empty. |
Map.Entry |
floorEntry(Object key) Returns a key-value mapping associated with the greatest key less than or equal to the given key, or if there is no such key. |
Object |
Returns the greatest key less than or equal to the given key, or if there is no such key. |
SortedMap |
|
NavigableMap |
Returns a view of the portion of this map whose keys are less than (or equal to, if is true) . |
Map.Entry |
higherEntry(Object key) Returns a key-value mapping associated with the least key strictly greater than the given key, or if there is no such key. |
Object |
Returns the least key strictly greater than the given key, or if there is no such key. |
Map.Entry |
Returns a key-value mapping associated with the greatest key in this map, or if the map is empty. |
Map.Entry |
lowerEntry(Object key) Returns a key-value mapping associated with the greatest key strictly less than the given key, or if there is no such key. |
Object |
Returns the greatest key strictly less than the given key, or if there is no such key. |
NavigableSet |
Returns a java.util.NavigableSet view of the keys contained in this map. |
Map.Entry |
Removes and returns a key-value mapping associated with the least key in this map, or if the map is empty. |
Map.Entry |
Removes and returns a key-value mapping associated with the greatest key in this map, or if the map is empty. |
NavigableMap |
Returns a view of the portion of this map whose keys range from to . |
SortedMap |
|
SortedMap |
|
NavigableMap |
Returns a view of the portion of this map whose keys are greater than (or equal to, if is true) . |
Methods inherited from class java.util.SortedMap |
---|
comparator, entrySet, firstKey, headMap, keySet, lastKey, subMap, tailMap, values |
Methods inherited from class java.util.Map |
---|
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values |
Method Detail |
---|
public Map.Entry ceilingEntry(Object key)
key
- the keypublic Object ceilingKey(Object key)
key
- the keypublic NavigableSet descendingKeySet()
public NavigableMap descendingMap()
The returned map has an ordering equivalent to {@link Collections#reverseOrder(Comparator) Collections.reverseOrder}(comparator()). The expression {@code m.descendingMap().descendingMap()} returns a view of {@code m} essentially equivalent to {@code m}.
public Map.Entry firstEntry()
public Map.Entry floorEntry(Object key)
key
- the keypublic Object floorKey(Object key)
key
- the keypublic SortedMap headMap(Object toKey)
Equivalent to {@code headMap(toKey, false)}.
toKey
public NavigableMap headMap(Object toKey, boolean inclusive)
The returned map will throw an {@code IllegalArgumentException} on an attempt to insert a key outside its range.
toKey
- high endpoint of the keys in the returned mapinclusive
- {@code true} if the high endpoint
is to be included in the returned viewpublic Map.Entry higherEntry(Object key)
key
- the keypublic Object higherKey(Object key)
key
- the keypublic Map.Entry lastEntry()
public Map.Entry lowerEntry(Object key)
key
- the keypublic Object lowerKey(Object key)
key
- the keypublic NavigableSet navigableKeySet()
public Map.Entry pollFirstEntry()
public Map.Entry pollLastEntry()
public NavigableMap subMap(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive)
The returned map will throw an {@code IllegalArgumentException} on an attempt to insert a key outside of its range, or to construct a submap either of whose endpoints lie outside its range.
fromKey
- low endpoint of the keys in the returned mapfromInclusive
- {@code true} if the low endpoint
is to be included in the returned viewtoKey
- high endpoint of the keys in the returned maptoInclusive
- {@code true} if the high endpoint
is to be included in the returned viewpublic SortedMap subMap(Object fromKey, Object toKey)
Equivalent to {@code subMap(fromKey, true, toKey, false)}.
fromKey
toKey
public SortedMap tailMap(Object fromKey)
Equivalent to {@code tailMap(fromKey, true)}.
fromKey
public NavigableMap tailMap(Object fromKey, boolean inclusive)
The returned map will throw an {@code IllegalArgumentException} on an attempt to insert a key outside its range.
fromKey
- low endpoint of the keys in the returned mapinclusive
- {@code true} if the low endpoint
is to be included in the returned view
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |