com.goldencode.p2j.util

Class TailIdentityHashMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.IdentityHashMap<K,V>

com.goldencode.p2j.util.TailIdentityHashMap<K,V>

Type Parameters:

K - Dictionary key type

V - Dictionary value type

All Implemented Interfaces:

TailMap<K,V>, TailMapInternal<K,V>, java.io.Serializable, java.lang.Cloneable, java.util.Map<K,V>

public class TailIdentityHashMap<K,V>
extends java.util.IdentityHashMap<K,V>
implements TailMapInternal<K,V>

A dictionary that supports registering new items in a new Map tail while iterating the collection.

See Also:

Serialized Form

Nested Class Summary

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

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

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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	iteratingActive Flag iterating state
private java.lang.AutoCloseable	iteratingActiveSegment Prevents nested use of IteratingActive
private static long	serialVersionUID Generated version UID
private java.util.Map<K,V>	tailingMap If iteratingActive is true, new items are added to tailingMap, since adding while iterating is prohibited.

Constructor Summary

Constructors

Constructor and Description
TailIdentityHashMap() Default constructor.
TailIdentityHashMap(int expectedMaxSize) Constructor with expected maximum size.

Method Summary

Modifier and Type	Method and Description
java.lang.AutoCloseable	flagIterating() The caller is responsible for setting the iterating active flag, by implementing a try(AutoCloseable obj = dict.flagIterating()) block.
private java.util.Map<K,V>	getOrCreateTailingMap() Get the tail map.
boolean	isIteratingActive() Reports if this dictionary has the "being iterated" flag.
java.util.Map<K,V>	pop() Do a 'pop' of the single tail dictionary.
V	put(K key, V value) Add or replace a key value pair at this key.
void	setIteratingActive(boolean iteratingActive) Sets the iterating active flag
void	setIteratingActiveSegment(java.lang.AutoCloseable iteratingActiveSegment) Sets the auto-closable object, which may be set once as soon as the iterating active flag becomes true.

Methods inherited from class java.util.IdentityHashMap

clear, clone, containsKey, containsValue, entrySet, equals, forEach, get, hashCode, isEmpty, keySet, putAll, remove, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.util.TailMapInternal

putAtDefault

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated version UID

See Also:

Constant Field Values

iteratingActive

private boolean iteratingActive

Flag iterating state

iteratingActiveSegment

private java.lang.AutoCloseable iteratingActiveSegment

Prevents nested use of IteratingActive

tailingMap

private java.util.Map<K,V> tailingMap

If iteratingActive is true, new items are added to tailingMap, since adding while iterating is prohibited. Use pop() to take control of this tail dictionary. The caller is responsible for iterating the tail.

Constructor Detail

TailIdentityHashMap

public TailIdentityHashMap()

Default constructor.

TailIdentityHashMap

public TailIdentityHashMap(int expectedMaxSize)

Constructor with expected maximum size.

Parameters:

expectedMaxSize - The expected maximum size of the hash map.

Method Detail

pop

public java.util.Map<K,V> pop()

Do a 'pop' of the single tail dictionary. The caller is responsible for iterating it.

Specified by:

pop in interface TailMap<K,V>

Returns:

null if no tail map present, otherwise a map with at least one item.

put

public V put(K key,
             V value)

Add or replace a key value pair at this key.

Specified by:

put in interface java.util.Map<K,V>

Overrides:

put in class java.util.IdentityHashMap<K,V>

Returns:

V

isIteratingActive

public boolean isIteratingActive()

Reports if this dictionary has the "being iterated" flag.

Specified by:

isIteratingActive in interface TailMap<K,V>

Returns:

true if this dictionary is being iterated.

flagIterating

public java.lang.AutoCloseable flagIterating()

The caller is responsible for setting the iterating active flag, by implementing a try(AutoCloseable obj = dict.flagIterating()) block.

Specified by:

flagIterating in interface TailMap<K,V>

Returns:

a new AutoClosable object.

setIteratingActive

public void setIteratingActive(boolean iteratingActive)

Sets the iterating active flag

Specified by:

setIteratingActive in interface TailMapInternal<K,V>

Parameters:

iteratingActive - Iterating active true or false.

setIteratingActiveSegment

public void setIteratingActiveSegment(java.lang.AutoCloseable iteratingActiveSegment)

Sets the auto-closable object, which may be set once as soon as the iterating active flag becomes true.

Specified by:

setIteratingActiveSegment in interface TailMapInternal<K,V>

Parameters:

iteratingActiveSegment - Pass the auto-closable object at the instant the iterating active flag becomes true. Pass null as soon as the iterating active flag becomes false.

getOrCreateTailingMap

private java.util.Map<K,V> getOrCreateTailingMap()

Get the tail map. Create it if not present.

Returns:

tailingMap.