FileDocCategorySizeDatePackage
ConcurrentNavigableMap.javaAPI DocJava SE 6 API6095Tue Jun 10 00:25:56 BST 2008java.util.concurrent

ConcurrentNavigableMap

public interface ConcurrentNavigableMap implements NavigableMap, ConcurrentMap
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.

author
Doug Lea
param
the type of keys maintained by this map
param
the type of mapped values
since
1.6

Fields Summary
Constructors Summary
Methods Summary
public java.util.NavigableSetdescendingKeySet()
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.

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

public java.util.concurrent.ConcurrentNavigableMapdescendingMap()
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}.

return
a reverse order view of this map

public java.util.concurrent.ConcurrentNavigableMapheadMap(K toKey, boolean inclusive)

throws
ClassCastException {@inheritDoc}
throws
NullPointerException {@inheritDoc}
throws
IllegalArgumentException {@inheritDoc}

public java.util.concurrent.ConcurrentNavigableMapheadMap(K toKey)

throws
ClassCastException {@inheritDoc}
throws
NullPointerException {@inheritDoc}
throws
IllegalArgumentException {@inheritDoc}

public java.util.NavigableSetkeySet()
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}.

return
a navigable set view of the keys in this map

public java.util.NavigableSetnavigableKeySet()
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.

return
a navigable set view of the keys in this map

public java.util.concurrent.ConcurrentNavigableMapsubMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)

throws
ClassCastException {@inheritDoc}
throws
NullPointerException {@inheritDoc}
throws
IllegalArgumentException {@inheritDoc}

public java.util.concurrent.ConcurrentNavigableMapsubMap(K fromKey, K toKey)

throws
ClassCastException {@inheritDoc}
throws
NullPointerException {@inheritDoc}
throws
IllegalArgumentException {@inheritDoc}

public java.util.concurrent.ConcurrentNavigableMaptailMap(K fromKey, boolean inclusive)

throws
ClassCastException {@inheritDoc}
throws
NullPointerException {@inheritDoc}
throws
IllegalArgumentException {@inheritDoc}

public java.util.concurrent.ConcurrentNavigableMaptailMap(K fromKey)

throws
ClassCastException {@inheritDoc}
throws
NullPointerException {@inheritDoc}
throws
IllegalArgumentException {@inheritDoc}