com.linkedin.parseq.batching

Class BatchImpl<K,T>

java.lang.Object

com.linkedin.parseq.batching.BatchImpl<K,T>

All Implemented Interfaces:

Batch<K,T>

public class BatchImpl<K,T>
extends Object
implements Batch<K,T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchImpl.BatchEntry<T>
static class	BatchImpl.BatchPromise<T> Internal Promise delegate that decouples setting value on internal Promise from publishing result on external promise.

Method Summary

Modifier and Type	Method and Description
int	batchSize() Returns size of this batch.
void	done(K key, T value) Completes a Promise associated with given key with a value.
Set<Map.Entry<K,BatchImpl.BatchEntry<T>>>	entries()
void	fail(K key, Throwable error) Fails a Promise associated with given key with an error.
int	failAll(Throwable error) Fails all promises belonging to this batch with given error.
void	foreach(BiConsumer<K,com.linkedin.parseq.promise.SettablePromise<T>> consumer) Performs the given action for each element of the batch until all elements have been processed or the action throws an exception.
Set<K>	keys() Returns set of keys belonging to this batch.
int	keySize() Returns number of keys belonging to this batch.
String	toString()
Collection<BatchImpl.BatchEntry<T>>	values()

Methods inherited from class java.lang.Object

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

Method Detail

done

public void done(K key,
                 T value)
          throws com.linkedin.parseq.promise.PromiseResolvedException

Description copied from interface: Batch

Completes a Promise associated with given key with a value. Throws PromiseResolvedException if Promise associated with given key has already been resolved.

Specified by:

done in interface Batch<K,T>

Parameters:

key - key that identifies a Promise to be completed

value - value to complete Promise with

Throws:

com.linkedin.parseq.promise.PromiseResolvedException - if Promise associated with given key has already been resolved

fail

public void fail(K key,
                 Throwable error)
          throws com.linkedin.parseq.promise.PromiseResolvedException

Description copied from interface: Batch

Fails a Promise associated with given key with an error. Throws PromiseResolvedException if Promise associated with given key has already been resolved.

Specified by:

fail in interface Batch<K,T>

Parameters:

key - key that identifies a Promise to be completed

error - error to fail Promise with

Throws:

com.linkedin.parseq.promise.PromiseResolvedException - if Promise associated with given key has already been resolved

failAll

public int failAll(Throwable error)

Description copied from interface: Batch

Fails all promises belonging to this batch with given error. If a promise belonging to this batch has already been completed then it is ignored by this method. This method guarantees that after it returns each Promise in this batch is either completed or failed.

Specified by:

failAll in interface Batch<K,T>

Parameters:

error - error that all promises belonging to this batch will be failed with

Returns:

number of promises that were not failed because the promise has already been resolved; if this method returns 0 it means that it successfully failed all promises belonging to this batch with specified error

keys

public Set<K> keys()

Description copied from interface: Batch

Returns set of keys belonging to this batch.

Specified by:

keys in interface Batch<K,T>

Returns:

set of keys belonging to this batch

foreach

public void foreach(BiConsumer<K,com.linkedin.parseq.promise.SettablePromise<T>> consumer)

Description copied from interface: Batch

Performs the given action for each element of the batch until all elements have been processed or the action throws an exception. Order in which elements are processed is unspecified. Exceptions thrown by the action are relayed to the caller.

Specified by:

foreach in interface Batch<K,T>

Parameters:

consumer - action to be performed in each element of the batch

toString

public String toString()

Overrides:

toString in class Object

values

public Collection<BatchImpl.BatchEntry<T>> values()

Specified by:

values in interface Batch<K,T>

entries

public Set<Map.Entry<K,BatchImpl.BatchEntry<T>>> entries()

Specified by:

entries in interface Batch<K,T>

keySize

public int keySize()

Description copied from interface: Batch

Returns number of keys belonging to this batch.

Specified by:

keySize in interface Batch<K,T>

Returns:

number of keys belonging to this batch.

batchSize

public int batchSize()

Description copied from interface: Batch

Returns size of this batch. This number is not necessarily equal to the number of keys belonging to this batch. This number might be different than number of keys if BatchingStrategy.keySize(Object, Object) is defined.

Specified by:

batchSize in interface Batch<K,T>

Returns:

size of this batch.