Package it.tidalwave.role.ui.spi

Class PresentationModelCollectors

java.lang.Object

it.tidalwave.util.spi.ArrayListCollectorSupport<PresentationModel,PresentationModel>

it.tidalwave.role.ui.spi.PresentationModelCollectors

All Implemented Interfaces:

java.util.stream.Collector<PresentationModel,java.util.List<PresentationModel>,PresentationModel>

public class PresentationModelCollectors
extends ArrayListCollectorSupport<PresentationModel,PresentationModel>

A Collector which collects a Stream of PresentationModels into a single PresentationModel with a Composite<PresentationModel> role containing them.

Author:

Fabrizio Giudici

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.stream.Collector

java.util.stream.Collector.Characteristics

Method Summary

Modifier and Type	Method	Description
java.util.function.Function<java.util.List<PresentationModel>,PresentationModel>	finisher()
static PresentationModelCollectors	toCompositePresentationModel()
static <T extends As> PresentationModel	toCompositePresentationModel(java.lang.Iterable<T> i)	A facility simplified version of toCompositePresentationModel(java.lang.Iterable, java.util.function.Function).
static <T extends As> PresentationModel	toCompositePresentationModel(java.lang.Iterable<T> i, java.util.function.Function<T,java.lang.Object> roleCreator)	A facility method that creates a composite PresentationModel out of an iterable (which means an array, a collection or a stream) of objects implementing As.
static PresentationModelCollectors	toCompositePresentationModel(java.util.Collection<java.lang.Object> roles)	A Collector which collects a Stream of PresentationModels into a single PresentationModel with a Composite role containing them.

Methods inherited from class it.tidalwave.util.spi.ArrayListCollectorSupport

accumulator, characteristics, combiner, supplier

Methods inherited from class java.lang.Object

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

Method Detail

toCompositePresentationModel

@Nonnull
public static PresentationModelCollectors toCompositePresentationModel(@Nonnull
                                                                       java.util.Collection<java.lang.Object> roles)

A Collector which collects a Stream of PresentationModels into a single PresentationModel with a Composite role containing them. In other words:

 List<PresentationModel> pms = ...
 PresentationModel compositePm = pms.stream().collect(toCompositePresentationModel());
 // same contents as childrenPms
 List<PresentationModel> childrenPms = compositePm.as(_Composite_).findChildren().results();
 

Parameters:

roles - some extra roles included in the resulting PresentationModel

Returns:

a PresentationModel

Since:

3.2-ALPHA-3 (refactored)

toCompositePresentationModel

@Nonnull
public static PresentationModelCollectors toCompositePresentationModel()

toCompositePresentationModel

@Nonnull
public static <T extends As> PresentationModel toCompositePresentationModel(@Nonnull
                                                                            java.lang.Iterable<T> i,
                                                                            @Nonnull
                                                                            java.util.function.Function<T,java.lang.Object> roleCreator)

A facility method that creates a composite PresentationModel out of an iterable (which means an array, a collection or a stream) of objects implementing As. For each object in the iterable, its PresentationModel is created by means of invoking its Presentable role. Then all the PresentationModels are aggregated into the composite. A function which creates specific roles for each PresentationModel can be specified. The function can return a single role or multiple roles in form of an array Object[].

Type Parameters:

T - the type of the objects

Parameters:

i - the Iterable

roleCreator - the function to create roles

Returns:

the composite PresentationModel

toCompositePresentationModel

@Nonnull
public static <T extends As> PresentationModel toCompositePresentationModel(@Nonnull
                                                                            java.lang.Iterable<T> i)

A facility simplified version of toCompositePresentationModel(java.lang.Iterable, java.util.function.Function).

Type Parameters:

T - the type of the objects

Parameters:

i - the Iterable

Returns:

the composite PresentationModel

finisher

@Nonnull
public java.util.function.Function<java.util.List<PresentationModel>,PresentationModel> finisher()