sirius.kernel.commons

Class DataCollector<T>

java.lang.Object

sirius.kernel.commons.DataCollector<T>

Type Parameters:

T - the type of objects to be collected

All Implemented Interfaces:

Consumer<T>

public class DataCollector<T>
extends Object
implements Consumer<T>

Provides a pull pattern for asking methods to compute or fill a List.

When asking methods to create or populate a List it's easier to create and pass along a Collector instead of having each method creating its own list and joining them afterwards.

By subclassing DataCollector one can also directly process the given values instead of just storing them in a list.

A typical use-case is:

 
             DataCollector<String> collector = new DataCollector<String>();
             computeStrings1(collector);
             computeStrings2(collector);

             collector.getData(); // use values
 
 

If a sorted list is required which does not depend on insertion order but on a given priority of each entry PriorityCollector can be used.

See Also:

PriorityCollector

Constructor Summary

Constructors

Constructor and Description
DataCollector()

Method Summary

Modifier and Type	Method and Description
void	accept(T t)
void	add(T entity) Adds a value to the collector
void	addAll(Collection<? extends T> entities) Adds all values of the given collection to the collector
static <T> DataCollector<T>	create() Creates a new DataCollector.
List<T>	getData() Returns the List of values which where added to the collector so far.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Detail

DataCollector

public DataCollector()

Method Detail

create

public static <T> DataCollector<T> create()

Creates a new DataCollector.

Boilerplate method, so one doesn't need to re-type the type parameters.

Type Parameters:

T - the type of objects created by the data collector

Returns:

a new DataCollector

add

public void add(T entity)

Adds a value to the collector

Parameters:

entity - contains the value to be added to the collector.

addAll

public void addAll(@Nonnull
                   Collection<? extends T> entities)

Adds all values of the given collection to the collector

Parameters:

entities - the collection of values added to the collector.

getData

@Nonnull
public List<T> getData()

Returns the List of values which where added to the collector so far.

For the sake of simplicity, this returns the internally used list. Therefore modifying this list, modifies the collector.

Returns:

the list of values supplied to the collector so far.

toString

public String toString()

Overrides:

toString in class Object

accept

public void accept(T t)

Specified by:

accept in interface Consumer<T>