org.platestack.structure.immutable

Interface ImmutableNavigableMap<K,V>

Type Parameters:

K - the type of map keys. The map is invariant on its key type, as it can accept key as a parameter (of containsKey for example) and return it in keys set.

V - the type of map values. The map is covariant on its value type.

All Superinterfaces:

ImmutableMap<K,V>, ImmutableSortedMap<K,V>

public ImmutableNavigableMap<K,V>
extends ImmutableSortedMap<K,V>

An interface that mimics the original NavigableMap but without exposing modification functions to Kotlin source codes.

Modifications are strictly forbidden after the map is created.

See Also:

NavigableMap

Method Summary

Modifier and Type	Method and Description
java.util.Map.Entry<K,V>	ceilingEntry(K key) Returns a key-value mapping associated with the least key greater than or equal to the given key, or null if there is no such key.
K	ceilingKey(K key) Returns the least key greater than or equal to the given key, or null if there is no such key.
java.util.Map.Entry<K,V>	firstEntry() Returns a key-value mapping associated with the least key in this map, or null if the map is empty.
java.util.Map.Entry<K,V>	floorEntry(K key) Returns a key-value mapping associated with the greatest key less than or equal to the given key, or null if there is no such key.
K	floorKey(K key) Returns the greatest key less than or equal to the given key, or null if there is no such key.
ImmutableNavigableMap<K,V>	getDescending() 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. If either map is modified while an iteration over a collection view of either map is in progress (except through the iterator's own remove operation), the results of the iteration are undefined.
ImmutableNavigableSet<K>	getDescendingKeys() 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. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
ImmutableNavigableSet<K>	getNavigableKeys() 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. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
ImmutableNavigableMap<K,V>	head(K toKey, boolean inclusive) Returns a view of the portion of this map whose keys are less than (or equal to, if inclusive is true) 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.
ImmutableSortedMap<K,V>	head(K toKey) See ImmutableSortedMap.head
java.util.Map.Entry<K,V>	higherEntry(K key) Returns a key-value mapping associated with the least key strictly greater than the given key, or null if there is no such key.
K	higherKey(K key) Returns the least key strictly greater than the given key, or null if there is no such key.
java.util.Map.Entry<K,V>	lastEntry() Returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
java.util.Map.Entry<K,V>	lowerEntry(K key) Returns a key-value mapping associated with the greatest key strictly less than the given key, or null if there is no such key.
K	lowerKey(K key) Returns the greatest key strictly less than the given key, or null if there is no such key.
java.util.Map.Entry<K,V>	pollFirstEntry() Removes and returns a key-value mapping associated with the least key in this map, or null if the map is empty.
java.util.Map.Entry<K,V>	pollLastEntry() Removes and returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
ImmutableNavigableMap<K,V>	sub(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive) Returns a view of the portion of this map whose keys range from fromKey to toKey. If fromKey and toKey are equal, the returned map is empty unless fromInclusive and toInclusive are both true. 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.
ImmutableSortedMap<K,V>	sub(K fromKey, K toKey) See ImmutableSortedMap.sub
ImmutableNavigableMap<K,V>	tail(K fromKey, boolean inclusive) Returns a view of the portion of this map whose keys are greater than (or equal to, if inclusive is true) 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.
ImmutableSortedMap<K,V>	tail(K fromKey) See ImmutableSortedMap.tail

Methods inherited from interface org.platestack.structure.immutable.ImmutableSortedMap

comparator, firstKey, getEntries, getKeys, getValues, head, lastKey, sub, tail

Method Detail

lowerEntry

java.util.Map.Entry<K,V> lowerEntry(K key)

Returns a key-value mapping associated with the greatest key strictly less than the given key, or null if there is no such key.

Parameters:

key - the key

Returns:

an entry with the greatest key less than key, or null if there is no such key

Throws:

- if the specified key cannot be compared with the keys currently in the map

- if the specified key is null and this map does not permit null keys

lowerKey

K lowerKey(K key)

Returns the greatest key strictly less than the given key, or null if there is no such key.

Parameters:

key - the key

Returns:

the greatest key less than key, or null if there is no such key

Throws:

- if the specified key cannot be compared with the keys currently in the map

- if the specified key is null and this map does not permit null keys

floorEntry

java.util.Map.Entry<K,V> floorEntry(K key)

Returns a key-value mapping associated with the greatest key less than or equal to the given key, or null if there is no such key.

Parameters:

key - the key

Returns:

an entry with the greatest key less than or equal to key, or null if there is no such key

Throws:

- if the specified key cannot be compared with the keys currently in the map

- if the specified key is null and this map does not permit null keys

floorKey

K floorKey(K key)

Returns the greatest key less than or equal to the given key, or null if there is no such key.

Parameters:

key - the key

Returns:

the greatest key less than or equal to key, or null if there is no such key

Throws:

- if the specified key cannot be compared with the keys currently in the map

- if the specified key is null and this map does not permit null keys

ceilingEntry

java.util.Map.Entry<K,V> ceilingEntry(K key)

Returns a key-value mapping associated with the least key greater than or equal to the given key, or null if there is no such key.

Parameters:

key - the key

Returns:

an entry with the least key greater than or equal to key, or null if there is no such key

Throws:

- if the specified key cannot be compared with the keys currently in the map

- if the specified key is null and this map does not permit null keys

ceilingKey

K ceilingKey(K key)

Returns the least key greater than or equal to the given key, or null if there is no such key.

Parameters:

key - the key

Returns:

the least key greater than or equal to key, or null if there is no such key

Throws:

- if the specified key cannot be compared with the keys currently in the map

- if the specified key is null and this map does not permit null keys

higherEntry

java.util.Map.Entry<K,V> higherEntry(K key)

Returns a key-value mapping associated with the least key strictly greater than the given key, or null if there is no such key.

Parameters:

key - the key

Returns:

an entry with the least key greater than key, or null if there is no such key

Throws:

- if the specified key cannot be compared with the keys currently in the map

- if the specified key is null and this map does not permit null keys

higherKey

K higherKey(K key)

Returns the least key strictly greater than the given key, or null if there is no such key.

Parameters:

key - the key

Returns:

the least key greater than key, or null if there is no such key

Throws:

- if the specified key cannot be compared with the keys currently in the map

- if the specified key is null and this map does not permit null keys

firstEntry

java.util.Map.Entry<K,V> firstEntry()

Returns a key-value mapping associated with the least key in this map, or null if the map is empty.

Returns:

an entry with the least key, or null if this map is empty

lastEntry

java.util.Map.Entry<K,V> lastEntry()

Returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.

Returns:

an entry with the greatest key, or null if this map is empty

pollFirstEntry

java.util.Map.Entry<K,V> pollFirstEntry()

Removes and returns a key-value mapping associated with the least key in this map, or null if the map is empty.

Returns:

the removed first entry of this map, or null if this map is empty

pollLastEntry

java.util.Map.Entry<K,V> pollLastEntry()

Removes and returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.

Returns:

the removed last entry of this map, or null if this map is empty

getDescending

ImmutableNavigableMap<K,V> getDescending()

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. If either map is modified while an iteration over a collection view of either map is in progress (except through the iterator's own remove operation), the results of the iteration are undefined.

The returned map has an ordering equivalent to Collections.reverseOrder. The expression m.descendingMap().descendingMap() returns a view of m essentially equivalent to m.

Returns:

a reverse order view of this map

See Also:

Collections.reverseOrder

getNavigableKeys

ImmutableNavigableSet<K> getNavigableKeys()

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. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:

a navigable set view of the keys in this map

See Also:

NavigableSet

getDescendingKeys

ImmutableNavigableSet<K> getDescendingKeys()

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. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:

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

See Also:

NavigableSet

sub

ImmutableNavigableMap<K,V> sub(K fromKey,
                               boolean fromInclusive,
                               K toKey,
                               boolean toInclusive)

Returns a view of the portion of this map whose keys range from fromKey to toKey. If fromKey and toKey are equal, the returned map is empty unless fromInclusive and toInclusive are both true. 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 of its range, or to construct a submap either of whose endpoints lie outside its range.

Parameters:

fromKey - low endpoint of the keys in the returned map

fromInclusive - true if the low endpoint is to be included in the returned view

toKey - high endpoint of the keys in the returned map

toInclusive - true if the high endpoint is to be included in the returned view

Returns:

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

Throws:

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

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

- 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

head

ImmutableNavigableMap<K,V> head(K toKey,
                                boolean inclusive)

Returns a view of the portion of this map whose keys are less than (or equal to, if inclusive is true) 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 of the keys in the returned map

inclusive - true if the high endpoint is to be included in the returned view

Returns:

a view of the portion of this map whose keys are less than (or equal to, if inclusive is true) toKey

Throws:

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

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

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

tail

ImmutableNavigableMap<K,V> tail(K fromKey,
                                boolean inclusive)

Returns a view of the portion of this map whose keys are greater than (or equal to, if inclusive is true) 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 of the keys in the returned map

inclusive - true if the low endpoint is to be included in the returned view

Returns:

a view of the portion of this map whose keys are greater than (or equal to, if inclusive is true) fromKey

Throws:

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

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

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

sub

ImmutableSortedMap<K,V> sub(K fromKey,
                            K toKey)

See ImmutableSortedMap.sub

Equivalent to subMap(fromKey, true, toKey, false).

head

ImmutableSortedMap<K,V> head(K toKey)

See ImmutableSortedMap.head

Equivalent to headMap(toKey, false).

tail

ImmutableSortedMap<K,V> tail(K fromKey)

See ImmutableSortedMap.tail

Equivalent to tailMap(fromKey, true).