com.hp.mercury.ci.jenkins.plugins.oo.utils

Class MapAggregator<T,R>

java.lang.Object

com.hp.mercury.ci.jenkins.plugins.oo.utils.MapAggregator<T,R>

Type Parameters:

R - the returned value of the handler function - the resulting map value type.

T - the type of the aggregated collection the resulting map key type.

All Implemented Interfaces:

Aggregator<Map<T,R>,T>

public class MapAggregator<T,R>
extends Object
implements Aggregator<Map<T,R>,T>

this aggregator maps the elements of the aggregated collection to the result of a function application on those elements. the function is set during the initialization of the aggregator instance and is passed as a Handler

Constructor Summary

Constructors

Constructor and Description
MapAggregator(Handler<R,T> valueCalculator)

Method Summary

Methods

Modifier and Type	Method and Description
void	aggregate(T element)
Map<T,R>	finish()
void	init(Collection<T> elements)

Methods inherited from class java.lang.Object

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

Constructor Detail

MapAggregator

public MapAggregator(Handler<R,T> valueCalculator)

Parameters:

valueCalculator - function to apply on the currently aggregated element to calculate it's mapped value

Method Detail

init

public void init(Collection<T> elements)

Specified by:

init in interface Aggregator<Map<T,R>,T>

Parameters:

elements - the container that's about to be iterated. use this function to initialize the aggregation process. for example, you might need to create a "result" collection and you can set it's size according to elements.size() for performance reasons.

aggregate

public void aggregate(T element)

Specified by:

aggregate in interface Aggregator<Map<T,R>,T>

Parameters:

element - the currently iterated element that you should add to the aggregation. if the aggregator implementation is to create a sum of integers, then an implementation for this method would be sum += element;

finish

public Map<T,R> finish()

Specified by:

finish in interface Aggregator<Map<T,R>,T>

Returns:

a mapping from the aggregated collection elements to values generated by applying a function on each, and binding the pair as key-value.