io.atomix.core.map

Interface AtomicSortedMap<K extends Comparable<K>,V>

All Superinterfaces:

AtomicMap<K,V>, DistributedPrimitive, SyncPrimitive

All Known Subinterfaces:

AtomicNavigableMap<K,V>

public interface AtomicSortedMap<K extends Comparable<K>,V>
extends AtomicMap<K,V>

Atomic sorted map.

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
AsyncAtomicSortedMap<K,V>	async() Returns the underlying asynchronous primitive.
K	firstKey() Returns the lowest key in the map.
AtomicSortedMap<K,V>	headMap(K toKey) Returns a view of the portion of this map whose keys are strictly less than toKey.
K	lastKey() Returns the highest key in the map.
AtomicSortedMap<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.
AtomicSortedMap<K,V>	tailMap(K fromKey) Returns a view of the portion of this map whose keys are greater than or equal to fromKey.

Methods inherited from interface io.atomix.core.map.AtomicMap

addListener, addListener, clear, compute, computeIf, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, get, getAllPresent, getOrDefault, isEmpty, keySet, put, put, putAndGet, putAndGet, putIfAbsent, putIfAbsent, remove, remove, remove, removeListener, replace, replace, replace, size, values

Methods inherited from interface io.atomix.primitive.SyncPrimitive

close, delete

Methods inherited from interface io.atomix.primitive.DistributedPrimitive

addStateChangeListener, name, protocol, removeStateChangeListener, type

Method Detail

firstKey

K firstKey()

Returns the lowest key in the map.

Returns:

the key or null if none exist

lastKey

K lastKey()

Returns the highest key in the map.

Returns:

the key or null if none exist

subMap

AtomicSortedMap<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. (If fromKey and toKey are equal, the returned map is empty.) The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

Parameters:

fromKey - low endpoint (inclusive) of the keys in the returned map

toKey - high endpoint (exclusive) of the keys in the returned map

Returns:

a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive

Throws:

ClassCastException - if fromKey and toKey cannot be compared to one another using this map's comparator (or, if the map has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if fromKey or toKey cannot be compared to keys currently in the map.

NullPointerException - if fromKey or toKey is null and this map does not permit null keys

IllegalArgumentException - if fromKey is greater than toKey; or if this map itself has a restricted range, and fromKey or toKey lies outside the bounds of the range

headMap

AtomicSortedMap<K,V> headMap(K toKey)

Returns a view of the portion of this map whose keys are strictly less than toKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

Parameters:

toKey - high endpoint (exclusive) of the keys in the returned map

Returns:

a view of the portion of this map whose keys are strictly less than toKey

Throws:

ClassCastException - if toKey is not compatible with this map's comparator (or, if the map has no comparator, if toKey does not implement Comparable). Implementations may, but are not required to, throw this exception if toKey cannot be compared to keys currently in the map.

NullPointerException - if toKey is null and this map does not permit null keys

IllegalArgumentException - if this map itself has a restricted range, and toKey lies outside the bounds of the range

tailMap

AtomicSortedMap<K,V> tailMap(K fromKey)

Returns a view of the portion of this map whose keys are greater than or equal to fromKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

Parameters:

fromKey - low endpoint (inclusive) of the keys in the returned map

Returns:

a view of the portion of this map whose keys are greater than or equal to fromKey

Throws:

ClassCastException - if fromKey is not compatible with this map's comparator (or, if the map has no comparator, if fromKey does not implement Comparable). Implementations may, but are not required to, throw this exception if fromKey cannot be compared to keys currently in the map.

NullPointerException - if fromKey is null and this map does not permit null keys

IllegalArgumentException - if this map itself has a restricted range, and fromKey lies outside the bounds of the range

async

AsyncAtomicSortedMap<K,V> async()

Description copied from interface: SyncPrimitive

Returns the underlying asynchronous primitive.

Specified by:

async in interface AtomicMap<K extends Comparable<K>,V>

Specified by:

async in interface SyncPrimitive

Returns:

the underlying asynchronous primitive