Package org.apache.qpid.protonj2.engine.util

Class UnsettledMap<Delivery>

java.lang.Object

org.apache.qpid.protonj2.engine.util.UnsettledMap<Delivery>

Type Parameters:

Delivery - The delivery type being tracker (incoming or outgoing)

All Implemented Interfaces:

Map<UnsignedInteger,Delivery>

public class UnsettledMap<Delivery>
extends Object
implements Map<UnsignedInteger,Delivery>

A specialized collection like entity that is used to keep track of unsettled incoming and outgoing deliveries for AMQP links and the sessions that manage those links.

While this class implements the Map interface it does not fully behave as a standard map as it solves the issue of tracking delivery IDs which always increase until such time as the unsigned integer value used to represents them overflows. It is possible (although unlikely) for the same ID to exist for multiple deliveries if an older delivery exists in the Map and the delivery IDs overflow and the same value is produced once again.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UnsettledMap.ImmutableUnsettledTrackingkMapEntry<Delivery>	An immutable Map entry that can be used when exposing raw entry mappings via the Map API.
static interface	UnsettledMap.UnsettledGetDeliveryId<Delivery>

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<Map.Entry<UnsignedInteger,Delivery>>	entrySet
protected Set<UnsignedInteger>	keySet
protected Collection<Delivery>	values

Constructor Summary

Constructors

Constructor	Description
UnsettledMap(UnsettledMap.UnsettledGetDeliveryId<Delivery> idSupplier)
UnsettledMap(UnsettledMap.UnsettledGetDeliveryId<Delivery> idSupplier, int initialBuckets)
UnsettledMap(UnsettledMap.UnsettledGetDeliveryId<Delivery> idSupplier, int initialBuckets, int bucketSize)

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(int deliveryId)
boolean	containsKey(Object key)
boolean	containsKey(UnsignedInteger key)
boolean	containsValue(Object value)
Set<Map.Entry<UnsignedInteger,Delivery>>	entrySet()
boolean	equals(Object o)
void	forEach(int first, int last, Consumer<Delivery> action)	Visits each entry within the given range and invokes the provided action on each delivery in the tracker.
void	forEach(BiConsumer<? super UnsignedInteger,? super Delivery> action)
void	forEach(Consumer<Delivery> action)	Visits each entry within the UnsettledMap and invokes the provided action on each delivery in the tracker.
Delivery	get(int deliveryId)
Delivery	get(Object key)
Delivery	get(UnsignedInteger key)
boolean	isEmpty()
Set<UnsignedInteger>	keySet()
Delivery	put(int deliveryId, Delivery delivery)	Adds the given key and value pair in this tracking structure at the end of the current series.
Delivery	put(UnsignedInteger key, Delivery value)
void	putAll(Map<? extends UnsignedInteger,? extends Delivery> source)
Delivery	remove(int deliveryId)
Delivery	remove(Object key)
Delivery	remove(UnsignedInteger key)
void	removeEach(int first, int last, Consumer<Delivery> action)	Remove each entry within the given range of delivery IDs.
int	size()
String	toString()
Collection<Delivery>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Field Details

keySet

protected Set<UnsignedInteger> keySet

values

protected Collection<Delivery> values

entrySet

protected Set<Map.Entry<UnsignedInteger,Delivery>> entrySet

Constructor Details

UnsettledMap

public UnsettledMap(UnsettledMap.UnsettledGetDeliveryId<Delivery> idSupplier)

UnsettledMap

public UnsettledMap(UnsettledMap.UnsettledGetDeliveryId<Delivery> idSupplier,
 int initialBuckets)

UnsettledMap

public UnsettledMap(UnsettledMap.UnsettledGetDeliveryId<Delivery> idSupplier,
 int initialBuckets,
 int bucketSize)

Method Details

putAll

public void putAll(Map<? extends UnsignedInteger,? extends Delivery> source)

Specified by:

putAll in interface Map<UnsignedInteger,Delivery>

clear

public void clear()

Specified by:

clear in interface Map<UnsignedInteger,Delivery>

put

public Delivery put(UnsignedInteger key,
 Delivery value)

Specified by:

put in interface Map<UnsignedInteger,Delivery>

put

public Delivery put(int deliveryId,
 Delivery delivery)

Adds the given key and value pair in this tracking structure at the end of the current series.

If the map previously contained a mapping for the key, the old value is not replaced by the specified value unlike a traditional map as this structure is tracking the running series of values. This would imply that duplicates can exist in the tracker, however given the likelihood of this occurring in the normal flow of deliveries should be considered extremely low.

Parameters:

deliveryId - The delivery ID of the delivery being added to this tracker.

delivery - The delivery that is being added to the tracker

Returns:

null in all cases as this Map type does not check for duplicates.

size

public int size()

Specified by:

size in interface Map<UnsignedInteger,Delivery>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<UnsignedInteger,Delivery>

get

public Delivery get(Object key)

Specified by:

get in interface Map<UnsignedInteger,Delivery>

get

public Delivery get(UnsignedInteger key)

get

public Delivery get(int deliveryId)

remove

public Delivery remove(Object key)

Specified by:

remove in interface Map<UnsignedInteger,Delivery>

remove

public Delivery remove(UnsignedInteger key)

remove

public Delivery remove(int deliveryId)

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<UnsignedInteger,Delivery>

containsKey

public boolean containsKey(UnsignedInteger key)

containsKey

public boolean containsKey(int deliveryId)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<UnsignedInteger,Delivery>

forEach

public void forEach(Consumer<Delivery> action)

Visits each entry within the UnsettledMap and invokes the provided action on each delivery in the tracker.

Parameters:

action - The action to invoke on each visited entry.

forEach

public void forEach(int first,
 int last,
 Consumer<Delivery> action)

Visits each entry within the given range and invokes the provided action on each delivery in the tracker. The lower and upper bounds are limits which are not exclusive meaning entries within this range are visited regards of there being an exact match on the lower and upper boundaries.

Parameters:

first - The lower bound of the first entry to visit.

last - The upper bound of the last entry to visit.

action - The action to invoke on each visited entry.

removeEach

public void removeEach(int first,
 int last,
 Consumer<Delivery> action)

Remove each entry within the given range of delivery IDs. For each entry removed the provided action is triggered allowing the caller to be notified of each removal.

Parameters:

first - The first entry to remove

last - The last entry to remove

action - The action to invoke on each remove.

forEach

public void forEach(BiConsumer<? super UnsignedInteger,? super Delivery> action)

Specified by:

forEach in interface Map<UnsignedInteger,Delivery>

values

public Collection<Delivery> values()

Specified by:

values in interface Map<UnsignedInteger,Delivery>

keySet

public Set<UnsignedInteger> keySet()

Specified by:

keySet in interface Map<UnsignedInteger,Delivery>

entrySet

public Set<Map.Entry<UnsignedInteger,Delivery>> entrySet()

Specified by:

entrySet in interface Map<UnsignedInteger,Delivery>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<UnsignedInteger,Delivery>

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object