edu.emory.mathcs.backport.java.util.concurrent

Interface ConcurrentNavigableMap

public interface ConcurrentNavigableMap extends ConcurrentMap, NavigableMap

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

This interface is a member of the Java Collections Framework.

Since: 1.6

Author: Doug Lea

Method Summary
NavigableSetdescendingKeySet()
Returns a reverse order NavigableSet view of the keys contained in this map.
NavigableMapdescendingMap()
Returns a reverse order view of the mappings contained in this map.
NavigableMapheadMap(Object toKey, boolean inclusive)
SortedMapheadMap(Object toKey)
SetkeySet()
Returns a NavigableSet view of the keys contained in this map.
NavigableSetnavigableKeySet()
Returns a NavigableSet view of the keys contained in this map.
NavigableMapsubMap(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive)
SortedMapsubMap(Object fromKey, Object toKey)
NavigableMaptailMap(Object fromKey, boolean inclusive)
SortedMaptailMap(Object fromKey)

Method Detail

descendingKeySet

public NavigableSet descendingKeySet()
Returns a reverse order 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 java.util.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 NavigableMap 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 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 NavigableMap headMap(Object toKey, boolean inclusive)

Throws: ClassCastException {@inheritDoc } NullPointerException {@inheritDoc } IllegalArgumentException {@inheritDoc }

headMap

public SortedMap headMap(Object toKey)

Throws: ClassCastException {@inheritDoc } NullPointerException {@inheritDoc } IllegalArgumentException {@inheritDoc }

keySet

public Set keySet()
Returns a 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 java.util.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 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 java.util.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 NavigableMap subMap(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive)

Throws: ClassCastException {@inheritDoc } NullPointerException {@inheritDoc } IllegalArgumentException {@inheritDoc }

subMap

public SortedMap subMap(Object fromKey, Object toKey)

Throws: ClassCastException {@inheritDoc } NullPointerException {@inheritDoc } IllegalArgumentException {@inheritDoc }

tailMap

public NavigableMap tailMap(Object fromKey, boolean inclusive)

Throws: ClassCastException {@inheritDoc } NullPointerException {@inheritDoc } IllegalArgumentException {@inheritDoc }

tailMap

public SortedMap tailMap(Object fromKey)

Throws: ClassCastException {@inheritDoc } NullPointerException {@inheritDoc } IllegalArgumentException {@inheritDoc }