net.bluemind.lib.vertx.utils

Class Debouncer<KEY,PAYLOAD>

java.lang.Object

net.bluemind.lib.vertx.utils.Debouncer<KEY,PAYLOAD>

public class Debouncer<KEY,PAYLOAD>
extends java.lang.Object

Block calls to the given BiConsumer in a debounce way. Allow the last call to be executed after a grace period (interval). Each call is identified using KEY. Only calls sharing the same identity block each others. Thread safe.

See Also:

https://stackoverflow.com/questions/4742210/implementing-debounce-in-java, http://reactivex.io/documentation/operators/debounce.html

Constructor Summary

Constructors

Constructor and Description
Debouncer(java.util.function.BiConsumer<KEY,PAYLOAD> consumer, int interval, boolean noDebounceFirst)

Method Summary

Modifier and Type	Method and Description
void	call(KEY key, PAYLOAD payload) Request a call to consumer, based on the given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

Debouncer

public Debouncer(java.util.function.BiConsumer<KEY,PAYLOAD> consumer,
                 int interval,
                 boolean noDebounceFirst)

Parameters:

consumer - the code to execute in a debounce way

interval - the debounce grace period in milliseconds

noDebounceFirst - the very first call (per key) will not suffer the grace period. It violates the real debounce pattern but may be useful in some cases.

Method Detail

call

public void call(KEY key,
                 PAYLOAD payload)

Request a call to consumer, based on the given key. The actual execution of the code depends on the debounce grace period: if no call with that key has been done within interval milliseconds then execute the last call.