Package com.inductiveautomation.ignition.designer.mvvm

Class Debouncer<T>

java.lang.Object

com.inductiveautomation.ignition.designer.mvvm.Debouncer<T>

public class Debouncer<T>
extends Object

This class is used to debounce data updates. If you need to know when the debouncer enters the active state, you can provide a callback to be called when the first data update is received after the waitTime has passed.

Constructor Summary

Constructors

Constructor	Description
Debouncer(long waitTime, Consumer<T> onDataCallback)	Use this variant of the constructor if you don't need to do anything when the debouncer enters the active state.
Debouncer(long waitTime, Consumer<T> onDataCallback, Consumer<T> onStartCallback)	This in the main constructor.

Method Summary

Modifier and Type	Method	Description
protected void	cancelCurrentTask()
protected void	notifyConsumer(T value)
protected void	scheduleTask(T value, long executionDelay)
void	update(T value)

Methods inherited from class java.lang.Object

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

Constructor Details

Debouncer

public Debouncer(long waitTime,
 Consumer<T> onDataCallback)

Use this variant of the constructor if you don't need to do anything when the debouncer enters the active state.

Parameters:

waitTime - The time to wait before calling the onDataCallback after the last data update.

onDataCallback - The callback to call when the waitTime has passed without any new data updates.

Debouncer

public Debouncer(long waitTime,
 Consumer<T> onDataCallback,
 @Nullable
 Consumer<T> onStartCallback)

This in the main constructor. The inactive state happens when there has been no new data updates to this class for the duration of the waitTime. The active state happens when this class receives new data updates.

Upon entering the active state, the onStartCallback is called if one is provided. It will remain in the active state until the waitTime has passed without any new data updates. When that happens the onDataCallback is called.

Parameters:

waitTime - The time to wait before calling the onDataCallback after the last data update.

onDataCallback - The callback to call when the waitTime has passed without any new data updates.

onStartCallback - The callback to call when the first data update is received after the waitTime has passed.

Method Details

update

public void update(T value)

cancelCurrentTask

protected void cancelCurrentTask()

scheduleTask

protected void scheduleTask(T value,
 long executionDelay)

notifyConsumer

protected void notifyConsumer(T value)