Package io.permazen.core.util

Class ObjIdMap<V>

java.lang.Object

java.util.AbstractMap<ObjId,V>

io.permazen.core.util.ObjIdMap<V>

All Implemented Interfaces:

Serializable, Cloneable, Map<ObjId,V>

@NotThreadSafe
public class ObjIdMap<V>
extends AbstractMap<ObjId,V>
implements Cloneable, Serializable

A map with ObjId keys.

This implementation is space optimized for the 64-bits of information contained in an ObjId. Instances do not accept null keys and are not thread safe.

Instances are Serializable if the map values.

See Also:

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

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

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	clear()
ObjIdMap<V>	clone()
boolean	containsKey(Object obj)
Set<Map.Entry<ObjId,V>>	entrySet()
V	get(Object obj)
int	hashCode()
boolean	isEmpty()
ObjIdSet	keySet()
V	put(ObjId id, V value)
V	remove(Object obj)
Map.Entry<ObjId,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

ObjIdMap

public ObjIdMap()

Constructs an empty instance.

ObjIdMap

public ObjIdMap(int capacity)

Constructs an instance with the given initial capacity.

Parameters:

capacity - initial capacity

Throws:

IllegalArgumentException - if capacity is negative

ObjIdMap

public ObjIdMap(Map<? extends ObjId,? 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<ObjId,V>

Overrides:

size in class AbstractMap<ObjId,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<ObjId,V>

Overrides:

isEmpty in class AbstractMap<ObjId,V>

containsKey

public boolean containsKey(Object obj)

Specified by:

containsKey in interface Map<ObjId,V>

Overrides:

containsKey in class AbstractMap<ObjId,V>

get

public V get(Object obj)

Specified by:

get in interface Map<ObjId,V>

Overrides:

get in class AbstractMap<ObjId,V>

put

public V put(ObjId id,
 V value)

Specified by:

put in interface Map<ObjId,V>

Overrides:

put in class AbstractMap<ObjId,V>

remove

public V remove(Object obj)

Specified by:

remove in interface Map<ObjId,V>

Overrides:

remove in class AbstractMap<ObjId,V>

clear

public void clear()

Specified by:

clear in interface Map<ObjId,V>

Overrides:

clear in class AbstractMap<ObjId,V>

keySet

public ObjIdSet keySet()

Specified by:

keySet in interface Map<ObjId,V>

Overrides:

keySet in class AbstractMap<ObjId,V>

entrySet

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

Specified by:

entrySet in interface Map<ObjId,V>

Specified by:

entrySet in class AbstractMap<ObjId,V>

removeOne

public Map.Entry<ObjId,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<ObjId,V>

Overrides:

hashCode in class AbstractMap<ObjId,V>

clone

public ObjIdMap<V> clone()

Overrides:

clone in class AbstractMap<ObjId,V>