Module org.jhotdraw8.icollection

Package org.jhotdraw8.icollection.immutable

Interface ImmutableNavigableMap<K,V>

Type Parameters:

K - the key type

V - the value type

All Superinterfaces:

ImmutableMap<K,V>, ImmutableSortedMap<K,V>, Iterable<Map.Entry<K,V>>, ReadOnlyMap<K,V>, ReadOnlyNavigableMap<K,V>, ReadOnlySequencedMap<K,V>, ReadOnlySortedMap<K,V>

All Known Implementing Classes:

RedBlackMap

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

An interface to an immutable navigable map; the implementation guarantees that the state of the collection does not change.

Method Summary

Modifier and Type	Method	Description
@NonNull ImmutableNavigableMap<K,V>	clear()	Returns a copy of this map that is empty.
@NonNull ImmutableNavigableMap<K,V>	put(@NonNull K key, @Nullable V value)	Returns a copy of this map that contains all entries of this map with the specified entry added or updated.
default @NonNull ImmutableNavigableMap<K,V>	putAll(@NonNull Iterable<? extends Map.Entry<? extends K,? extends V>> c)	Returns a copy of this map that contains all entries of this map with entries from the specified map added or updated.
default @NonNull ImmutableNavigableMap<K,V>	putAll(@NonNull Map<? extends K,? extends V> m)	Returns a copy of this map that contains all entries of this map with entries from the specified map added or updated.
default @NonNull ImmutableNavigableMap<K,V>	putKeyValues(@NonNull Object @NonNull ... kv)	Returns a copy of this map that contains all entries of this map with entries from the specified map added or updated.
@NonNull ImmutableNavigableMap<K,V>	remove(@NonNull K key)	Returns a copy of this map that contains all entries of this map with the specified entry removed.
default @NonNull ImmutableNavigableMap<K,V>	removeAll(@NonNull Iterable<? extends K> c)	Returns a copy of this map that contains all entries of this map except the entries of the specified collection.
default @NonNull ImmutableNavigableMap<K,V>	retainAll(@NonNull Iterable<? extends K> c)	Returns a copy of this map that contains only entries that are in this map and in the specified collection.
default @NonNull ImmutableNavigableMap<K,V>	retainAll(@NonNull ReadOnlyCollection<? extends K> c)	Returns a copy of this map that contains only entries that are in this map and in the specified collection.

Methods inherited from interface org.jhotdraw8.icollection.immutable.ImmutableMap

maxSize, toMutable

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlyMap

containsEntry, containsKey, containsValue, equals, get, getOrDefault, hashCode, isEmpty, iterator, size

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlyNavigableMap

ceilingEntry, ceilingKey, floorEntry, floorKey, higherEntry, higherKey, lowerEntry, lowerKey

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlySequencedMap

asMap, firstEntry, lastEntry, readOnlyEntrySet, readOnlyKeySet, readOnlyReversed, readOnlyValues

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlySortedMap

characteristics, comparator, spliterator

Method Details

clear

@NonNull ImmutableNavigableMap<K,V> clear()

Description copied from interface: ImmutableMap

Returns a copy of this map that is empty.

Specified by:

clear in interface ImmutableMap<K,V>

Specified by:

clear in interface ImmutableSortedMap<K,V>

Returns:

this set instance if it is already empty, or a different set instance that is empty.

put

@NonNull ImmutableNavigableMap<K,V> put(@NonNull K key,
 @Nullable V value)

Description copied from interface: ImmutableMap

Returns a copy of this map that contains all entries of this map with the specified entry added or updated.

Specified by:

put in interface ImmutableMap<K,V>

Specified by:

put in interface ImmutableSortedMap<K,V>

Parameters:

key - the key of the entry

value - the value of the entry

Returns:

this map instance if it already contains the same entry, or a different map instance with the entry added or updated

putAll

default @NonNull ImmutableNavigableMap<K,V> putAll(@NonNull Map<? extends K,? extends V> m)

Description copied from interface: ImmutableMap

Returns a copy of this map that contains all entries of this map with entries from the specified map added or updated.

Specified by:

putAll in interface ImmutableMap<K,V>

Specified by:

putAll in interface ImmutableSortedMap<K,V>

Parameters:

m - another map

Returns:

this map instance if it already contains the same entries, or a different map instance with the entries added or updated

putAll

default @NonNull ImmutableNavigableMap<K,V> putAll(@NonNull Iterable<? extends Map.Entry<? extends K,? extends V>> c)

Description copied from interface: ImmutableMap

Returns a copy of this map that contains all entries of this map with entries from the specified map added or updated.

Specified by:

putAll in interface ImmutableMap<K,V>

Specified by:

putAll in interface ImmutableSortedMap<K,V>

Parameters:

c - another map

Returns:

this map instance if it already contains the same entries, or a different map instance with the entries added or updated

putKeyValues

default @NonNull ImmutableNavigableMap<K,V> putKeyValues(@NonNull Object @NonNull ... kv)

Description copied from interface: ImmutableMap

Returns a copy of this map that contains all entries of this map with entries from the specified map added or updated.

Specified by:

putKeyValues in interface ImmutableMap<K,V>

Specified by:

putKeyValues in interface ImmutableSortedMap<K,V>

Parameters:

kv - a list of alternating keys and values

Returns:

this map instance if it already contains the same entries, or a different map instance with the entries added or updated

remove

@NonNull ImmutableNavigableMap<K,V> remove(@NonNull K key)

Description copied from interface: ImmutableMap

Returns a copy of this map that contains all entries of this map with the specified entry removed.

Specified by:

remove in interface ImmutableMap<K,V>

Specified by:

remove in interface ImmutableSortedMap<K,V>

Parameters:

key - the key of the entry

Returns:

this map instance if it already does not contain the entry, or a different map instance with the entry removed

removeAll

default @NonNull ImmutableNavigableMap<K,V> removeAll(@NonNull Iterable<? extends K> c)

Description copied from interface: ImmutableMap

Returns a copy of this map that contains all entries of this map except the entries of the specified collection.

Specified by:

removeAll in interface ImmutableMap<K,V>

Specified by:

removeAll in interface ImmutableSortedMap<K,V>

Parameters:

c - a collection with keys of entries to be removed from this map

Returns:

this map instance if it already does not contain the entries, or a different map instance with the entries removed

retainAll

default @NonNull ImmutableNavigableMap<K,V> retainAll(@NonNull Iterable<? extends K> c)

Description copied from interface: ImmutableMap

Returns a copy of this map that contains only entries that are in this map and in the specified collection.

Specified by:

retainAll in interface ImmutableMap<K,V>

Specified by:

retainAll in interface ImmutableSortedMap<K,V>

Parameters:

c - a collection with keys of entries to be retained in this map

Returns:

this map instance if it has not changed, or a different map instance with entries removed

retainAll

default @NonNull ImmutableNavigableMap<K,V> retainAll(@NonNull ReadOnlyCollection<? extends K> c)

Description copied from interface: ImmutableMap

Returns a copy of this map that contains only entries that are in this map and in the specified collection.

Specified by:

retainAll in interface ImmutableMap<K,V>

Specified by:

retainAll in interface ImmutableSortedMap<K,V>

Parameters:

c - a collection with keys of entries to be retained in this map

Returns:

this map instance if it has not changed, or a different map instance with entries removed