This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

java.util.concurrent
interface ConcurrentNavigableMap

All Superinterfaces:
Map, NavigableMap, SortedMap
All Known Implementing Classes:
ConcurrentSkipListMap
Most common way to construct:

ObjectInputStream in = …;

ConcurrentNavigableMap r = (ConcurrentNavigableMap)in.readObject();

Based on 8 examples 

public interface ConcurrentNavigableMap
extends NavigableMap

A {@link ConcurrentMap} supporting {@link NavigableMap} operations, and recursively so for its navigable sub-maps.

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
 NavigableSet
descendingKeySet()

          Returns a reverse order java.util.NavigableSet view of the keys contained in this map.
 ConcurrentNavigableMap
descendingMap()

          Returns a reverse order view of the mappings contained in this map.
 ConcurrentNavigableMap
headMap(Object toKey)

          
 ConcurrentNavigableMap
headMap(Object toKey, boolean inclusive)

          
 NavigableSet
keySet()

          Returns a java.util.NavigableSet view of the keys contained in this map.
 NavigableSet
navigableKeySet()

          Returns a java.util.NavigableSet view of the keys contained in this map.
 ConcurrentNavigableMap
subMap(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive)

          
 ConcurrentNavigableMap
subMap(Object fromKey, Object toKey)

          
 ConcurrentNavigableMap
tailMap(Object fromKey)

          
 ConcurrentNavigableMap
tailMap(Object fromKey, boolean inclusive)

          
 
Methods inherited from class java.util.NavigableMap
ceilingEntry, ceilingKey, descendingKeySet, descendingMap, firstEntry, floorEntry, floorKey, headMap, headMap, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, subMap, subMap, tailMap, tailMap
 
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

descendingKeySet

public NavigableSet descendingKeySet()
Returns a reverse order {@link NavigableSet} view of the keys contained in this map. The set's iterator returns the keys in descending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. The set supports element removal, which removes the corresponding mapping from the map, via the {@code Iterator.remove}, {@code Set.remove}, {@code removeAll}, {@code retainAll}, and {@code clear} operations. It does not support the {@code add} or {@code addAll} operations.

The view's {@code iterator} is a "weakly consistent" iterator that will never throw {@link ConcurrentModificationException}, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.

Returns:
a reverse order navigable set view of the keys in this map

descendingMap

public ConcurrentNavigableMap descendingMap()
Returns a reverse order view of the mappings contained in this map. The descending map is backed by this map, so changes to the map are reflected in the descending map, and vice-versa.

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}.

Returns:
a reverse order view of this map

headMap

public ConcurrentNavigableMap headMap(Object toKey)
Parameters:
toKey

headMap

public ConcurrentNavigableMap headMap(Object toKey,
                                      boolean inclusive)
Parameters:
toKey
inclusive

keySet

public NavigableSet keySet()
Returns a {@link NavigableSet} view of the keys contained in this map. The set's iterator returns the keys in ascending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. The set supports element removal, which removes the corresponding mapping from the map, via the {@code Iterator.remove}, {@code Set.remove}, {@code removeAll}, {@code retainAll}, and {@code clear} operations. It does not support the {@code add} or {@code addAll} operations.

The view's {@code iterator} is a "weakly consistent" iterator that will never throw {@link ConcurrentModificationException}, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.

This method is equivalent to method {@code navigableKeySet}.

Returns:
a navigable set view of the keys in this map

navigableKeySet

public NavigableSet navigableKeySet()
Returns a {@link NavigableSet} view of the keys contained in this map. The set's iterator returns the keys in ascending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. The set supports element removal, which removes the corresponding mapping from the map, via the {@code Iterator.remove}, {@code Set.remove}, {@code removeAll}, {@code retainAll}, and {@code clear} operations. It does not support the {@code add} or {@code addAll} operations.

The view's {@code iterator} is a "weakly consistent" iterator that will never throw {@link ConcurrentModificationException}, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.

Returns:
a navigable set view of the keys in this map

subMap

public ConcurrentNavigableMap subMap(Object fromKey,
                                     boolean fromInclusive,
                                     Object toKey,
                                     boolean toInclusive)
Parameters:
fromKey
fromInclusive
toKey
toInclusive

subMap

public ConcurrentNavigableMap subMap(Object fromKey,
                                     Object toKey)
Parameters:
fromKey
toKey

tailMap

public ConcurrentNavigableMap tailMap(Object fromKey)
Parameters:
fromKey

tailMap

public ConcurrentNavigableMap tailMap(Object fromKey,
                                      boolean inclusive)
Parameters:
fromKey
inclusive
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.