Package org.dellroad.stuff.util

Class LongMap<V>

java.lang.Object

java.util.AbstractMap<Long,V>

org.dellroad.stuff.util.LongMap<V>

All Implemented Interfaces:

Serializable, Cloneable, Map<Long,V>

public class LongMap<V>
extends AbstractMap<Long,V>
implements Cloneable, Serializable

A map with non-zero long keys.

This implementation uses long[] arrays and open addressing to minimize memory overhead. Equivalent Map methods taking long instead of Long are also provided.

Instances will throw IllegalStateException if their capacity is exceeded.

Instances do not accept zero keys and are not thread safe.

See Also:

• Open addressing
• Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
LongMap()	Constructs an empty instance.
LongMap(int capacity)	Constructs an instance with the given initial capacity.
LongMap(Map<? extends Number,? extends V> map)	Constructs an instance initialized from the given map.

Method Summary

Modifier and Type	Method	Description
void	clear()
LongMap<V>	clone()
boolean	containsKey(long key)
boolean	containsKey(Object obj)
LongMap<V>	deepClone(UnaryOperator<V> valueCloner)	Perform a "deep clone" operation, which is a normal clone() followed by a cloning of each value using the provided clone function.
Set<Map.Entry<Long,V>>	entrySet()
V	get(long key)
V	get(Object obj)
int	hashCode()
boolean	isEmpty()
LongSet	keySet()
V	put(long key, V value)
V	put(Long key, V value)
V	remove(long key)
V	remove(Object obj)
Map.Entry<Long,V>	removeOne()	Remove a single, arbitrary entry from this instance and return it.
int	size()

Methods inherited from class java.util.AbstractMap

containsValue, equals, putAll, toString, values

Methods inherited from class java.lang.Object

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 Details

LongMap

public LongMap()

Constructs an empty instance.

LongMap

public LongMap(int capacity)

Constructs an instance with the given initial capacity.

Parameters:

capacity - initial capacity

Throws:

IllegalArgumentException - if capacity is negative

LongMap

public LongMap(Map<? extends Number,? extends V> map)

Constructs an instance initialized from the given map.

Parameters:

map - initial contents for this instance

Throws:

NullPointerException - if map is null

IllegalArgumentException - if map contains a null key

Method Details

size

public int size()

Specified by:

size in interface Map<Long,V>

Overrides:

size in class AbstractMap<Long,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Long,V>

Overrides:

isEmpty in class AbstractMap<Long,V>

containsKey

public boolean containsKey(Object obj)

Specified by:

containsKey in interface Map<Long,V>

Overrides:

containsKey in class AbstractMap<Long,V>

containsKey

public boolean containsKey(long key)

get

public V get(Object obj)

Specified by:

get in interface Map<Long,V>

Overrides:

get in class AbstractMap<Long,V>

get

public V get(long key)

put

public V put(Long key,
 V value)

Specified by:

put in interface Map<Long,V>

Overrides:

put in class AbstractMap<Long,V>

put

public V put(long key,
 V value)

remove

public V remove(Object obj)

Specified by:

remove in interface Map<Long,V>

Overrides:

remove in class AbstractMap<Long,V>

remove

public V remove(long key)

clear

public void clear()

Specified by:

clear in interface Map<Long,V>

Overrides:

clear in class AbstractMap<Long,V>

keySet

public LongSet keySet()

Specified by:

keySet in interface Map<Long,V>

Overrides:

keySet in class AbstractMap<Long,V>

entrySet

public Set<Map.Entry<Long,V>> entrySet()

Specified by:

entrySet in interface Map<Long,V>

Specified by:

entrySet in class AbstractMap<Long,V>

removeOne

public Map.Entry<Long,V> removeOne()

Remove a single, arbitrary entry from this instance and return it.

Returns:

the removed entry, or null if this instance is empty

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<Long,V>

Overrides:

hashCode in class AbstractMap<Long,V>

clone

public LongMap<V> clone()

Overrides:

clone in class AbstractMap<Long,V>

deepClone

public LongMap<V> deepClone(UnaryOperator<V> valueCloner)

Perform a "deep clone" operation, which is a normal clone() followed by a cloning of each value using the provided clone function.

Parameters:

valueCloner - used to clone the individual values in this map

Returns:

a deeply cloned copy of this instance

Throws:

IllegalArgumentException - if valueCloner is null