com.bluegosling.collections.maps

Class SortedArrayMap<K,V>

java.lang.Object

com.bluegosling.collections.AbstractNavigableMap<K,V>

com.bluegosling.collections.maps.SortedArrayMap<K,V>

All Implemented Interfaces:

Serializable, Cloneable, Map<K,V>, NavigableMap<K,V>, SortedMap<K,V>

public class SortedArrayMap<K,V>
extends AbstractNavigableMap<K,V>
implements Serializable, Cloneable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.bluegosling.collections.AbstractNavigableMap

AbstractNavigableMap.BaseIteratorImpl<T>, AbstractNavigableMap.DescendingKeyIteratorImpl, AbstractNavigableMap.EntryIteratorImpl, AbstractNavigableMap.EntrySet, AbstractNavigableMap.KeyIteratorImpl, AbstractNavigableMap.KeySet, AbstractNavigableMap.SubMap, AbstractNavigableMap.ValueCollection, AbstractNavigableMap.ValueIteratorImpl

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

Map.Entry<K,V>

Field Summary

Fields inherited from class com.bluegosling.collections.AbstractNavigableMap

comparator, modCount

Constructor Summary

Constructors

Constructor and Description
SortedArrayMap()
SortedArrayMap(Comparator<? super K> comparator)
SortedArrayMap(int initialCapacity)
SortedArrayMap(int initialCapacity, Comparator<? super K> comparator)
SortedArrayMap(Map<? extends K,? extends V> map)
SortedArrayMap(Map<? extends K,? extends V> map, Comparator<? super K> comparator)
SortedArrayMap(SortedMap<K,? extends V> map)

Method Summary

Modifier and Type	Method and Description
Map.Entry<K,V>	ceilingEntry(K key)
Map.Entry<K,V>	firstEntry()
Map.Entry<K,V>	floorEntry(K key)
protected Map.Entry<K,V>	getEntry(Object key) Finds an entry for a specified key.
Map.Entry<K,V>	higherEntry(K key)
Map.Entry<K,V>	lastEntry()
Map.Entry<K,V>	lowerEntry(K key)
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> map)
protected Map.Entry<K,V>	removeEntry(Object key) Removes a mapping for the specified key and returns the removed entry.
int	size()
void	trimToSize() Shrinks the internal array so that it is exactly the necessary size.

Methods inherited from class com.bluegosling.collections.AbstractNavigableMap

ceilingKey, clear, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, equals, firstKey, floorKey, get, getModCount, hashCode, headMap, headMap, higherKey, isEmpty, keySet, lastKey, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, remove, subMap, subMap, tailMap, tailMap, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SortedArrayMap

public SortedArrayMap()

SortedArrayMap

public SortedArrayMap(int initialCapacity)

SortedArrayMap

public SortedArrayMap(Comparator<? super K> comparator)

SortedArrayMap

public SortedArrayMap(int initialCapacity,
                      Comparator<? super K> comparator)

SortedArrayMap

public SortedArrayMap(Map<? extends K,? extends V> map)

SortedArrayMap

public SortedArrayMap(Map<? extends K,? extends V> map,
                      Comparator<? super K> comparator)

SortedArrayMap

public SortedArrayMap(SortedMap<K,? extends V> map)

Method Detail

trimToSize

public void trimToSize()

Shrinks the internal array so that it is exactly the necessary size. Attempts to add an item to the set after this is called will cause it to grow the internal array to fit the new item.

putAll

public void putAll(Map<? extends K,? extends V> map)

Description copied from class: AbstractNavigableMap

This default implementation simply loops over all entries in the specified map and calls Map.put(Object, Object) for each one.

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class AbstractNavigableMap<K,V>

lowerEntry

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

Specified by:

lowerEntry in interface NavigableMap<K,V>

floorEntry

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

Description copied from class: AbstractNavigableMap

This default implementation uses AbstractNavigableMap.getEntry(Object). If no such entry is found then it calls NavigableMap.lowerEntry(Object) and returns that entry.

Specified by:

floorEntry in interface NavigableMap<K,V>

Overrides:

floorEntry in class AbstractNavigableMap<K,V>

ceilingEntry

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

Description copied from class: AbstractNavigableMap

This default implementation uses AbstractNavigableMap.getEntry(Object). If no such entry is found then it calls NavigableMap.higherEntry(Object) and returns that entry.

Specified by:

ceilingEntry in interface NavigableMap<K,V>

Overrides:

ceilingEntry in class AbstractNavigableMap<K,V>

higherEntry

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

Specified by:

higherEntry in interface NavigableMap<K,V>

firstEntry

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

Specified by:

firstEntry in interface NavigableMap<K,V>

lastEntry

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

Specified by:

lastEntry in interface NavigableMap<K,V>

size

public int size()

Specified by:

size in interface Map<K,V>

put

public V put(K key,
             V value)

Specified by:

put in interface Map<K,V>

getEntry

protected Map.Entry<K,V> getEntry(Object key)

Description copied from class: AbstractNavigableMap

Finds an entry for a specified key. If the key does not exist in the map then null is returned.

Specified by:

getEntry in class AbstractNavigableMap<K,V>

Parameters:

key - the key

Returns:

the entry in the map for the specified key or null if one does not exist

removeEntry

protected Map.Entry<K,V> removeEntry(Object key)

Description copied from class: AbstractNavigableMap

Removes a mapping for the specified key and returns the removed entry. If the key does not exist in the map then null is returned.

Specified by:

removeEntry in class AbstractNavigableMap<K,V>

Parameters:

key - the key

Returns:

the entry in the map that was removed or null if no such entry exists