ca.uhn.hl7v2.concurrent

Interface BlockingMap<K,V>

All Superinterfaces:

Map<K,V>

All Known Implementing Classes:

BlockingHashMap

public interface BlockingMap<K,V>
extends Map<K,V>

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
Future<V>	asyncPoll(K key, long timeout, TimeUnit unit) Polls for an entry in a background thread.
Future<V>	asyncTake(K key) Waits for an entry in a background thread.
boolean	give(K key, V value) Adds an entry only if there's already a consumer waiting for the value.
V	poll(K key, long timeout, TimeUnit unit) Waits for the specified amount of time for an entry with the given key and returns the associated value.
V	take(K key) Waits for an entry for the given key and returns the associated value.

Methods inherited from interface java.util.Map

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

Method Detail

give

boolean give(K key,
             V value)

Adds an entry only if there's already a consumer waiting for the value.

Parameters:

key - key for the entry to be added

value - entry to be added

Returns:

true if entry was added and a consumer is already waiting for the value, false otherwise

take

V take(K key)
throws InterruptedException

Waits for an entry for the given key and returns the associated value. May return null if the producer withdraws the entry without providing a value.

Parameters:

key - key for the entry

Returns:

the value of the entry

Throws:

InterruptedException

asyncTake

Future<V> asyncTake(K key)
             throws InterruptedException

Waits for an entry in a background thread.

Parameters:

key - key for the entry

Returns:

Future the result

Throws:

InterruptedException

poll

V poll(K key,
       long timeout,
       TimeUnit unit)
throws InterruptedException

Waits for the specified amount of time for an entry with the given key and returns the associated value. Returns null if no value was provided within the poll time. May return null if the producer withdraws the entry without providing a value.

Parameters:

key - key for the entry

timeout - timeout before the methods returns

unit - time unit used in conjunction with timout

Returns:

the value of the entry

Throws:

InterruptedException

asyncPoll

Future<V> asyncPoll(K key,
                    long timeout,
                    TimeUnit unit)
             throws InterruptedException

Polls for an entry in a background thread.

Parameters:

key - key for the entry

Returns:

Future the result

Throws:

InterruptedException