Module org.jhotdraw8.icollection

Package org.jhotdraw8.icollection

Class MutableRedBlackMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

org.jhotdraw8.icollection.MutableRedBlackMap<K,V>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Map.Entry<K,V>>, Map<K,V>, NavigableMap<K,V>, SequencedMap<K,V>, SortedMap<K,V>, ReadOnlyMap<K,V>, ReadOnlyNavigableMap<K,V>, ReadOnlySequencedMap<K,V>, ReadOnlySortedMap<K,V>

public class MutableRedBlackMap<K,V>
extends AbstractMap<K,V>
implements NavigableMap<K,V>, ReadOnlyNavigableMap<K,V>, Cloneable, Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
MutableRedBlackMap()	Constructs a new empty map, using the natural ordering of its keys.
MutableRedBlackMap(@NonNull Iterable<? extends Map.Entry<? extends K,? extends V>> m)	Constructs a map containing the same entries as in the specified Iterable, using the natural ordering of its keys.
MutableRedBlackMap(@NonNull Map<? extends K,? extends V> m)	Constructs a map containing the same entries as in the specified Map, using the natural ordering of its keys.
MutableRedBlackMap(@NonNull SortedMap<? extends K,? extends V> m)	Constructs a map containing the same entries as in the specified Map, using the same ordering as used by the provided map.
MutableRedBlackMap(@Nullable Comparator<? super K> comparator)	Constructs a new empty map, that uses the specified comparator for ordering its keys.

Method Summary

Modifier and Type	Method	Description
Map.Entry<K,V>	ceilingEntry(K key)	Returns the least entry in this map with a key greater than or equal to the given key, or null if there is no such entry.
K	ceilingKey(K key)	Returns the least entry in this map with a key greater than or equal to the given key, or null if there is no such key.
void	clear()
MutableRedBlackMap<K,V>	clone()
@Nullable Comparator<? super K>	comparator()	Returns the comparator used to order the keys in this map, or null if this set uses the natural ordering of its keys.
boolean	containsKey(Object key)	Returns true if this map contains a entry for the specified key.
boolean	containsValue(Object value)	Returns true if this map contains one or more keys to the specified value.
NavigableSet<K>	descendingKeySet()
NavigableMap<K,V>	descendingMap()
@NonNull Set<Map.Entry<K,V>>	entrySet()
@Nullable Map.Entry<K,V>	firstEntry()	Gets the first entry in this map or null if this map is empty.
K	firstKey()
Map.Entry<K,V>	floorEntry(K key)	Returns the greatest entry in this map with a key less than or equal to the given key, or null if there is no such entry.
K	floorKey(K key)	Returns the greatest key in this map less than or equal to the given key, or null if there is no such key.
@Nullable V	get(Object key)	Returns the value to which the key is mapped, or null if this map contains no entry for the key.
V	getOrDefault(@NonNull Object key, V defaultValue)	Returns the value to which the key is mapped, or the specified default value if this map contains no entry for the key.
@NonNull SortedMap<K,V>	headMap(K toKey)
NavigableMap<K,V>	headMap(K toKey, boolean inclusive)
Map.Entry<K,V>	higherEntry(K key)	Returns the least entry in this map with a key greater than the given key, or null if there is no such entry.
K	higherKey(K key)	Returns the least key in this map greater than the given key, or null if there is no such key.
@NonNull Iterator<Map.Entry<K,V>>	iterator()	Returns an iterator over the entries contained in this map.
@NonNull Set<K>	keySet()
@Nullable Map.Entry<K,V>	lastEntry()	Gets the last entry in this map or null if this map is empty.
K	lastKey()
Map.Entry<K,V>	lowerEntry(K key)	Returns the greatest entry in this map with a key less than the given key, or null if there is no such entry.
K	lowerKey(K key)	Returns the greatest key in this map less than the given key, or null if there is no such key.
NavigableSet<K>	navigableKeySet()
@Nullable Map.Entry<K,V>	pollFirstEntry()
@Nullable Map.Entry<K,V>	pollLastEntry()
@Nullable V	put(K key, V value)
void	putAll(Iterable<? extends Map.Entry<? extends K,? extends V>> m)
@NonNull ReadOnlySequencedMap<K,V>	readOnlyReversed()	Returns a reversed-order view of this map.
@Nullable V	remove(Object key)
int	size()	Returns the number of entries contained in this map..
@NonNull Spliterator<Map.Entry<K,V>>	spliterator()	Returns a spliterator over the entries contained in this map.
NavigableMap<K,V>	subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
@NonNull SortedMap<K,V>	subMap(K fromKey, K toKey)
@NonNull SortedMap<K,V>	tailMap(K fromKey)
NavigableMap<K,V>	tailMap(K fromKey, boolean inclusive)
RedBlackMap<K,V>	toImmutable()
@NonNull Collection<V>	values()

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, putAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface java.util.NavigableMap

reversed

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

containsEntry, equals, hashCode, isEmpty

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

asMap, readOnlyEntrySet, readOnlyKeySet, readOnlyValues

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

characteristics

Methods inherited from interface java.util.SequencedMap

sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface java.util.SortedMap

putFirst, putLast

Constructor Details

MutableRedBlackMap

public MutableRedBlackMap()

Constructs a new empty map, using the natural ordering of its keys.

MutableRedBlackMap

public MutableRedBlackMap(@Nullable Comparator<? super K> comparator)

Constructs a new empty map, that uses the specified comparator for ordering its keys.

Parameters:

comparator - the comparator that will be used to order this map. If null, the natural ordering of the keys is used.

MutableRedBlackMap

public MutableRedBlackMap(@NonNull Map<? extends K,? extends V> m)

Constructs a map containing the same entries as in the specified Map, using the natural ordering of its keys.

Parameters:

m - a map

MutableRedBlackMap

public MutableRedBlackMap(@NonNull SortedMap<? extends K,? extends V> m)

Constructs a map containing the same entries as in the specified Map, using the same ordering as used by the provided map.

Parameters:

m - a map

MutableRedBlackMap

public MutableRedBlackMap(@NonNull Iterable<? extends Map.Entry<? extends K,? extends V>> m)

Constructs a map containing the same entries as in the specified Iterable, using the natural ordering of its keys.

Parameters:

m - an iterable

Method Details

clone

public MutableRedBlackMap<K,V> clone()

Overrides:

clone in class AbstractMap<K,V>

lowerEntry

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

Description copied from interface: ReadOnlyNavigableMap

Returns the greatest entry in this map with a key less than the given key, or null if there is no such entry.

Specified by:

lowerEntry in interface NavigableMap<K,V>

Specified by:

lowerEntry in interface ReadOnlyNavigableMap<K,V>

Parameters:

key - the given key

Returns:

lower entry or null

lowerKey

public K lowerKey(K key)

Description copied from interface: ReadOnlyNavigableMap

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

Specified by:

lowerKey in interface NavigableMap<K,V>

Specified by:

lowerKey in interface ReadOnlyNavigableMap<K,V>

Parameters:

key - the given key

Returns:

lower key or null

floorEntry

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

Description copied from interface: ReadOnlyNavigableMap

Returns the greatest entry in this map with a key less than or equal to the given key, or null if there is no such entry.

Specified by:

floorEntry in interface NavigableMap<K,V>

Specified by:

floorEntry in interface ReadOnlyNavigableMap<K,V>

Parameters:

key - the given key

Returns:

floor entry or null

floorKey

public K floorKey(K key)

Description copied from interface: ReadOnlyNavigableMap

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

Specified by:

floorKey in interface NavigableMap<K,V>

Specified by:

floorKey in interface ReadOnlyNavigableMap<K,V>

Parameters:

key - the given key

Returns:

floor key or null

ceilingEntry

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

Description copied from interface: ReadOnlyNavigableMap

Returns the least entry in this map with a key greater than or equal to the given key, or null if there is no such entry.

Specified by:

ceilingEntry in interface NavigableMap<K,V>

Specified by:

ceilingEntry in interface ReadOnlyNavigableMap<K,V>

Parameters:

key - the given key

Returns:

ceiling entry or null

ceilingKey

public K ceilingKey(K key)

Description copied from interface: ReadOnlyNavigableMap

Returns the least entry in this map with a key greater than or equal to the given key, or null if there is no such key.

Specified by:

ceilingKey in interface NavigableMap<K,V>

Specified by:

ceilingKey in interface ReadOnlyNavigableMap<K,V>

Parameters:

key - the given key

Returns:

ceiling key or null

higherEntry

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

Description copied from interface: ReadOnlyNavigableMap

Returns the least entry in this map with a key greater than the given key, or null if there is no such entry.

Specified by:

higherEntry in interface NavigableMap<K,V>

Specified by:

higherEntry in interface ReadOnlyNavigableMap<K,V>

Parameters:

key - the given key

Returns:

higher entry or null

higherKey

public K higherKey(K key)

Description copied from interface: ReadOnlyNavigableMap

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

Specified by:

higherKey in interface NavigableMap<K,V>

Specified by:

higherKey in interface ReadOnlyNavigableMap<K,V>

Parameters:

key - the given key

Returns:

higher key or null

readOnlyReversed

public @NonNull ReadOnlySequencedMap<K,V> readOnlyReversed()

Description copied from interface: ReadOnlySequencedMap

Returns a reversed-order view of this map.

Changes to the underlying map are visible in the reversed view.

Specified by:

readOnlyReversed in interface ReadOnlySequencedMap<K,V>

Returns:

a reversed-order view of this map

firstEntry

public @Nullable Map.Entry<K,V> firstEntry()

Description copied from interface: ReadOnlySequencedMap

Gets the first entry in this map or null if this map is empty.

Specified by:

firstEntry in interface NavigableMap<K,V>

Specified by:

firstEntry in interface ReadOnlySequencedMap<K,V>

Specified by:

firstEntry in interface SequencedMap<K,V>

Returns:

the first entry or null

lastEntry

public @Nullable Map.Entry<K,V> lastEntry()

Description copied from interface: ReadOnlySequencedMap

Gets the last entry in this map or null if this map is empty.

Specified by:

lastEntry in interface NavigableMap<K,V>

Specified by:

lastEntry in interface ReadOnlySequencedMap<K,V>

Specified by:

lastEntry in interface SequencedMap<K,V>

Returns:

the last entry or null

pollFirstEntry

public @Nullable Map.Entry<K,V> pollFirstEntry()

Specified by:

pollFirstEntry in interface NavigableMap<K,V>

Specified by:

pollFirstEntry in interface SequencedMap<K,V>

pollLastEntry

public @Nullable Map.Entry<K,V> pollLastEntry()

Specified by:

pollLastEntry in interface NavigableMap<K,V>

Specified by:

pollLastEntry in interface SequencedMap<K,V>

descendingMap

public NavigableMap<K,V> descendingMap()

Specified by:

descendingMap in interface NavigableMap<K,V>

navigableKeySet

public NavigableSet<K> navigableKeySet()

Specified by:

navigableKeySet in interface NavigableMap<K,V>

descendingKeySet

public NavigableSet<K> descendingKeySet()

Specified by:

descendingKeySet in interface NavigableMap<K,V>

subMap

public NavigableMap<K,V> subMap(K fromKey,
 boolean fromInclusive,
 K toKey,
 boolean toInclusive)

Specified by:

subMap in interface NavigableMap<K,V>

headMap

public NavigableMap<K,V> headMap(K toKey,
 boolean inclusive)

Specified by:

headMap in interface NavigableMap<K,V>

tailMap

public NavigableMap<K,V> tailMap(K fromKey,
 boolean inclusive)

Specified by:

tailMap in interface NavigableMap<K,V>

comparator

public @Nullable Comparator<? super K> comparator()

Description copied from interface: ReadOnlySortedMap

Returns the comparator used to order the keys in this map, or null if this set uses the natural ordering of its keys.

Specified by:

comparator in interface ReadOnlySortedMap<K,V>

Specified by:

comparator in interface SortedMap<K,V>

Returns:

comparator or null

subMap

public @NonNull SortedMap<K,V> subMap(K fromKey,
 K toKey)

Specified by:

subMap in interface NavigableMap<K,V>

Specified by:

subMap in interface SortedMap<K,V>

headMap

public @NonNull SortedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface NavigableMap<K,V>

Specified by:

headMap in interface SortedMap<K,V>

tailMap

public @NonNull SortedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface NavigableMap<K,V>

Specified by:

tailMap in interface SortedMap<K,V>

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K,V>

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K,V>

size

public int size()

Description copied from interface: ReadOnlyMap

Returns the number of entries contained in this map..

Specified by:

size in interface Map<K,V>

Specified by:

size in interface ReadOnlyMap<K,V>

Overrides:

size in class AbstractMap<K,V>

Returns:

the number of entries

containsKey

public boolean containsKey(Object key)

Description copied from interface: ReadOnlyMap

Returns true if this map contains a entry for the specified key.

Specified by:

containsKey in interface Map<K,V>

Specified by:

containsKey in interface ReadOnlyMap<K,V>

Overrides:

containsKey in class AbstractMap<K,V>

Parameters:

key - a key

Returns:

true if this map contains a entry for the specified key

containsValue

public boolean containsValue(Object value)

Description copied from interface: ReadOnlyMap

Returns true if this map contains one or more keys to the specified value.

Specified by:

containsValue in interface Map<K,V>

Specified by:

containsValue in interface ReadOnlyMap<K,V>

Overrides:

containsValue in class AbstractMap<K,V>

Parameters:

value - a value

Returns:

true if this map maps one or more keys to the specified value

get

public @Nullable V get(Object key)

Description copied from interface: ReadOnlyMap

Returns the value to which the key is mapped, or null if this map contains no entry for the key.

Specified by:

get in interface Map<K,V>

Specified by:

get in interface ReadOnlyMap<K,V>

Overrides:

get in class AbstractMap<K,V>

Parameters:

key - a key

Returns:

the mapped value or null

put

public @Nullable V put(K key,
 V value)

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractMap<K,V>

remove

public @Nullable V remove(Object key)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractMap<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractMap<K,V>

toImmutable

public RedBlackMap<K,V> toImmutable()

iterator

public @NonNull Iterator<Map.Entry<K,V>> iterator()

Description copied from interface: ReadOnlyMap

Returns an iterator over the entries contained in this map.

Specified by:

iterator in interface Iterable<K>

Specified by:

iterator in interface ReadOnlyMap<K,V>

Returns:

an iterator

spliterator

public @NonNull Spliterator<Map.Entry<K,V>> spliterator()

Description copied from interface: ReadOnlySortedMap

Returns a spliterator over the entries contained in this map.

Specified by:

spliterator in interface Iterable<K>

Specified by:

spliterator in interface ReadOnlyMap<K,V>

Specified by:

spliterator in interface ReadOnlySortedMap<K,V>

Returns:

a spliterator

entrySet

public @NonNull Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface SortedMap<K,V>

Specified by:

entrySet in class AbstractMap<K,V>

keySet

public @NonNull Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface SortedMap<K,V>

Overrides:

keySet in class AbstractMap<K,V>

values

public @NonNull Collection<V> values()

Specified by:

values in interface Map<K,V>

Specified by:

values in interface SortedMap<K,V>

Overrides:

values in class AbstractMap<K,V>

getOrDefault

public V getOrDefault(@NonNull Object key,
 V defaultValue)

Description copied from interface: ReadOnlyMap

Returns the value to which the key is mapped, or the specified default value if this map contains no entry for the key.

Specified by:

getOrDefault in interface Map<K,V>

Specified by:

getOrDefault in interface ReadOnlyMap<K,V>

Parameters:

key - a key

defaultValue - a default value

Returns:

the mapped value or the specified default value

putAll

public void putAll(Iterable<? extends Map.Entry<? extends K,? extends V>> m)