Interface BatchingThreshold<E> (2.19.1)

public interface BatchingThreshold<E>

The interface representing a threshold to be used in ThresholdBatcher. Thresholds do not need to be thread-safe if they are only used inside ThresholdBatcher.

Type Parameter

NameDescription
E

Methods

accumulate(E e)

public abstract void accumulate(E e)

Presents the element to the threshold for the attribute of interest to be accumulated.

Any calls into this function from ThresholdBatcher will be under a lock.

Parameter
NameDescription
eE

copyWithZeroedValue()

public abstract BatchingThreshold<E> copyWithZeroedValue()

Make a copy of this threshold but with the accumulated value zeroed.

Any calls into this function from ThresholdBatcher will be under a lock.

Returns
TypeDescription
BatchingThreshold<E>

isThresholdReached()

public abstract boolean isThresholdReached()

Any calls into this function from ThresholdBatcher will be under a lock.

Returns
TypeDescription
boolean

whether the threshold has been reached.