FastSortedMap (Javolution Core (Java) 6.0.0 API)

java.lang.Object
- javolution.util.FastMap<K,V>
- - javolution.util.FastSortedMap<K,V>

All Implemented Interfaces:

Serializable, ConcurrentMap<K,V>, Map<K,V>, SortedMap<K,V>
```
public class FastSortedMap<K,V>
extends FastMap<K,V>
implements SortedMap<K,V>
```
A high-performance sorted map with real-time behavior.

This map provides a total ordering based on the keys natural order or using custom comparators.

Version:

6.0, July 21, 2013

Author:

Jean-Marie Dautelle

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Modifier	Constructor and Description
	`FastSortedMap()` Creates an empty sorted map ordered on keys natural order.
	`FastSortedMap(Equality<? super K> keyComparator)` Creates an empty sorted map ordered using the specified comparator for order.
	`FastSortedMap(Equality<? super K> keyComparator, Equality<? super V> valueComparator)` Creates an empty sorted map ordered using the specified key comparator for order and value comparator for values equality.
`protected`	`FastSortedMap(SortedMapService<K,V> service)` Creates a sorted map backed up by the specified service implementation.

Method Summary

Methods
Modifier and Type	Method and Description
`FastSortedMap<K,V>`	`atomic()` Returns an atomic view over this map.
`Comparator<? super K>`	`comparator()` Returns the comparator used to order the keys in this map (never null).
`boolean`	`containsKey(Object key)` Indicates if this map contains the specified key.
`FastSortedSet<Map.Entry<K,V>>`	`entrySet()` Returns a set view of the mappings contained in this map.
`K`	`firstKey()` Returns the first (lowest) key currently in this map.
`V`	`get(Object key)` Returns the value for the specified key.
`FastSortedMap<K,V>`	`headMap(K toKey)` Returns a view of the portion of this map whose keys are strictly less than toKey.
`FastSortedSet<K>`	`keySet()` Returns a set view of the keys contained in this map.
`K`	`lastKey()` Returns the last (highest) key currently in this map.
`V`	`put(K key, V value)` Associates the specified value with the specified key.
`FastSortedMap<K,V>`	`putAll(FastMap<? extends K,? extends V> that)` Returns this map with the specified map's entries added.
`V`	`putIfAbsent(K key, V value)` Associates the specified value with the specified key only if the specified key has no current mapping.
`V`	`remove(Object key)` Removes the entry for the specified key.
`boolean`	`remove(Object key, Object value)` Removes the entry for a key only if currently mapped to a given value.
`V`	`replace(K key, V value)` Replaces the entry for a key only if currently mapped to some value.
`boolean`	`replace(K key, V oldValue, V newValue)` Replaces the entry for a key only if currently mapped to a given value.
`protected SortedMapService<K,V>`	`service()` Returns this map service implementation.
`FastSortedMap<K,V>`	`shared()` Returns a thread-safe view over this map.
`FastSortedMap<K,V>`	`subMap(K fromKey, K toKey)` Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.
`FastSortedMap<K,V>`	`tailMap(K fromKey)` Returns a view of the portion of this map whose keys are greater than or equal to fromKey.
`FastSortedMap<K,V>`	`unmodifiable()` Returns an unmodifiable view over this map.

Methods inherited from class javolution.util.FastMap
clear, containsValue, isEmpty, parallel, perform, putAll, sequential, size, toImmutable, toString, update, values

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.SortedMap
values

Methods inherited from interface java.util.Map
clear, containsValue, equals, hashCode, isEmpty, putAll, size

- Constructor Detail
  - FastSortedMap
```
public FastSortedMap()
```
    Creates an empty sorted map ordered on keys natural order.
  - FastSortedMap
```
public FastSortedMap(Equality<? super K> keyComparator)
```
    Creates an empty sorted map ordered using the specified comparator for order.
  - FastSortedMap
```
public FastSortedMap(Equality<? super K> keyComparator,
             Equality<? super V> valueComparator)
```
    Creates an empty sorted map ordered using the specified key comparator for order and value comparator for values equality.
  - FastSortedMap
```
protected FastSortedMap(SortedMapService<K,V> service)
```
    Creates a sorted map backed up by the specified service implementation.
- Method Detail
  - atomic
```
public FastSortedMap<K,V> atomic()
```
    Description copied from class: FastMap
    
    Returns an atomic view over this map. All operations that write or access multiple elements in the map (such as putAll(), keySet().retainAll(), ...) are atomic. Iterators on atomic collections are thread-safe (no ConcurrentModificationException possible).
    
    Overrides:
    
    atomic in class FastMap<K,V>
  - shared
```
public FastSortedMap<K,V> shared()
```
    Description copied from class: FastMap
    
    Returns a thread-safe view over this map. The shared view allows for concurrent read as long as there is no writer. The default implementation is based on readers-writers locks giving priority to writers. Iterators on shared collections are thread-safe (no ConcurrentModificationException possible).
    
    Overrides:
    
    shared in class FastMap<K,V>
  - unmodifiable
```
public FastSortedMap<K,V> unmodifiable()
```
    Description copied from class: FastMap
    
    Returns an unmodifiable view over this map. Any attempt to modify the map through this view will result into a UnsupportedOperationException being raised.
    
    Overrides:
    
    unmodifiable in class FastMap<K,V>
  - entrySet
```
public FastSortedSet<Map.Entry<K,V>> entrySet()
```
    Description copied from class: FastMap
    
    Returns a set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. The set support adding/removing entries. As far as the set is concerned, two entries are considered equals if they have the same keys regardless of their values.
    
    Specified by:
    
    entrySet in interface Map<K,V>
    
    Specified by:
    
    entrySet in interface SortedMap<K,V>
    
    Overrides:
    
    entrySet in class FastMap<K,V>
  - keySet
```
public FastSortedSet<K> keySet()
```
    Description copied from class: FastMap
    
    Returns a set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. The set supports adding new keys for which the corresponding entry value is always null.
    
    Specified by:
    
    keySet in interface Map<K,V>
    
    Specified by:
    
    keySet in interface SortedMap<K,V>
    
    Overrides:
    
    keySet in class FastMap<K,V>
  - subMap
```
public FastSortedMap<K,V> subMap(K fromKey,
                        K toKey)
```
    Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.
    
    Specified by:
    
    subMap in interface SortedMap<K,V>
  - headMap
```
public FastSortedMap<K,V> headMap(K toKey)
```
    Returns a view of the portion of this map whose keys are strictly less than toKey.
    
    Specified by:
    
    headMap in interface SortedMap<K,V>
  - tailMap
```
public FastSortedMap<K,V> tailMap(K fromKey)
```
    Returns a view of the portion of this map whose keys are greater than or equal to fromKey.
    
    Specified by:
    
    tailMap in interface SortedMap<K,V>
  - containsKey
```
@Realtime(limit=LOG_N)
public boolean containsKey(Object key)
```
    Description copied from class: FastMap
    
    Indicates if this map contains the specified key.
    
    Specified by:
    
    containsKey in interface Map<K,V>
    
    Overrides:
    
    containsKey in class FastMap<K,V>
  - get
```
@Realtime(limit=LOG_N)
public V get(Object key)
```
    Description copied from class: FastMap
    
    Returns the value for the specified key.
    
    Specified by:
    
    get in interface Map<K,V>
    
    Overrides:
    
    get in class FastMap<K,V>
  - put
```
@Realtime(limit=LOG_N)
public V put(K key,
                       V value)
```
    Description copied from class: FastMap
    
    Associates the specified value with the specified key.
    
    Specified by:
    
    put in interface Map<K,V>
    
    Overrides:
    
    put in class FastMap<K,V>
  - remove
```
@Realtime(limit=LOG_N)
public V remove(Object key)
```
    Description copied from class: FastMap
    
    Removes the entry for the specified key.
    
    Specified by:
    
    remove in interface Map<K,V>
    
    Overrides:
    
    remove in class FastMap<K,V>
  - putIfAbsent
```
@Realtime(limit=LOG_N)
public V putIfAbsent(K key,
                               V value)
```
    Description copied from class: FastMap
    
    Associates the specified value with the specified key only if the specified key has no current mapping.
    
    Specified by:
    
    putIfAbsent in interface ConcurrentMap<K,V>
    
    Overrides:
    
    putIfAbsent in class FastMap<K,V>
  - remove
```
@Realtime(limit=LOG_N)
public boolean remove(Object key,
                                Object value)
```
    Description copied from class: FastMap
    
    Removes the entry for a key only if currently mapped to a given value.
    
    Specified by:
    
    remove in interface ConcurrentMap<K,V>
    
    Overrides:
    
    remove in class FastMap<K,V>
  - replace
```
@Realtime(limit=LOG_N)
public boolean replace(K key,
                                 V oldValue,
                                 V newValue)
```
    Description copied from class: FastMap
    
    Replaces the entry for a key only if currently mapped to a given value.
    
    Specified by:
    
    replace in interface ConcurrentMap<K,V>
    
    Overrides:
    
    replace in class FastMap<K,V>
  - replace
```
@Realtime(limit=LOG_N)
public V replace(K key,
                           V value)
```
    Description copied from class: FastMap
    
    Replaces the entry for a key only if currently mapped to some value.
    
    Specified by:
    
    replace in interface ConcurrentMap<K,V>
    
    Overrides:
    
    replace in class FastMap<K,V>
  - firstKey
```
public K firstKey()
```
    Returns the first (lowest) key currently in this map.
    
    Specified by:
    
    firstKey in interface SortedMap<K,V>
  - lastKey
```
public K lastKey()
```
    Returns the last (highest) key currently in this map.
    
    Specified by:
    
    lastKey in interface SortedMap<K,V>
  - comparator
```
public Comparator<? super K> comparator()
```
    Returns the comparator used to order the keys in this map (never null).
    
    Specified by:
    
    comparator in interface SortedMap<K,V>
  - putAll
```
public FastSortedMap<K,V> putAll(FastMap<? extends K,? extends V> that)
```
    Description copied from class: FastMap
    
    Returns this map with the specified map's entries added.
    
    Overrides:
    
    putAll in class FastMap<K,V>
  - service
```
protected SortedMapService<K,V> service()
```
    Description copied from class: FastMap
    
    Returns this map service implementation.
    
    Overrides:
    
    service in class FastMap<K,V>

Class FastSortedMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class javolution.util.FastMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

FastSortedMap

FastSortedMap

FastSortedMap

FastSortedMap

Method Detail

atomic

shared

unmodifiable

entrySet

keySet

subMap

headMap

tailMap

containsKey

get

put

remove

putIfAbsent

remove

replace

replace

firstKey

lastKey

comparator

putAll

service