de.vandermeer.skb.interfaces.transformers

Interface ClusterElementTransformer

public interface ClusterElementTransformer

A transformer for clusters (iterable, iterator, array) to collections with transformations on each element of the input group.

Since:

v0.0.1

Version:

v0.0.1 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Method Summary

Modifier and Type	Method and Description
static ClusterElementTransformer	create() Creates a new transformer.
default <T1,T2,T3 extends T1,S extends Collection<T2>> S	transform(Iterable<T3> input, Transformer<T1,T2> transformer, IsCollectionStrategy<S,T2> strategy) Converts the input iterable to a collection applying a transformation for each input element.
default <T1,T2,T3 extends T1,S extends Collection<T2>> S	transform(Iterable<T3> input, Transformer<T1,T2> transformer, Predicate<T3> predicate, IsCollectionStrategy<S,T2> strategy) Converts the input iterable to a collection applying a predicate and a transformation for each input element.
default <T1,T2,T3 extends T1,S extends Collection<T2>> S	transform(Iterator<T3> input, Transformer<T1,T2> transformer, IsCollectionStrategy<S,T2> strategy) Converts the input iterator to a collection applying a transformation for each input element.
default <T1,T2,T3 extends T1,S extends Collection<T2>> S	transform(Iterator<T3> input, Transformer<T1,T2> transformer, Predicate<T3> predicate, IsCollectionStrategy<S,T2> strategy) Converts the input iterator to a collection applying a predicate and a transformation for each input element.
default <T1,T2,T3 extends T1,S extends Collection<T2>> S	transform(T3[] input, Transformer<T1,T2> transformer, IsCollectionStrategy<S,T2> strategy) Converts the input array to a collection applying a transformation for each input element.
default <T1,T2,T3 extends T1,S extends Collection<T2>> S	transform(T3[] input, Transformer<T1,T2> transformer, Predicate<T3> predicate, IsCollectionStrategy<S,T2> strategy) Converts the input array to a collection applying a predicate and a transformation for each input element.

Method Detail

transform

default <T1,T2,T3 extends T1,S extends Collection<T2>> S transform(Iterable<T3> input,
                                                                   Transformer<T1,T2> transformer,
                                                                   IsCollectionStrategy<S,T2> strategy)

Converts the input iterable to a collection applying a transformation for each input element.

Type Parameters:

T1 - the from/source of the transformer (also the type for iterable)

T2 - the to/target of the transformer and the type of objects in the return collection

T3 - any type that extends T1 to no limit conversion to a single type

S - the type of collection that should be returned

Parameters:

input - iterable of input elements

transformer - a transformer to apply for each input element before copying to the output

strategy - a strategy determining the type of output collection

Returns:

an empty collection of type T2 or a collection of type T2 with transformed objects from the input collection

Throws:

NullPointerException - if input, transformer, or strategy was null

transform

default <T1,T2,T3 extends T1,S extends Collection<T2>> S transform(Iterable<T3> input,
                                                                   Transformer<T1,T2> transformer,
                                                                   Predicate<T3> predicate,
                                                                   IsCollectionStrategy<S,T2> strategy)

Converts the input iterable to a collection applying a predicate and a transformation for each input element.

Type Parameters:

T1 - the from/source of the transformer (also the type for iterable)

T2 - the to/target of the transformer and the type of objects in the return collection

T3 - any type that extends T1 to no limit conversion to a single type

S - the type of collection that should be returned

Parameters:

input - iterable of input elements

transformer - a transformer to apply for each input element before copying to the output

predicate - a predicate to apply before transformation and copy of each input element (ignored if null)

strategy - a strategy determining the type of output collection

Returns:

an empty collection of type T2 or a collection of type T2 with transformed objects from the input collection

Throws:

NullPointerException - if input, transformer, or strategy was null

transform

default <T1,T2,T3 extends T1,S extends Collection<T2>> S transform(Iterator<T3> input,
                                                                   Transformer<T1,T2> transformer,
                                                                   IsCollectionStrategy<S,T2> strategy)

Converts the input iterator to a collection applying a transformation for each input element.

Type Parameters:

T1 - the from/source of the transformer (also the type for the iterator)

T2 - the to/target of the transformer and the type of objects in the return collection

T3 - any type that extends T1 to no limit conversion to a single type

S - the type of collection that should be returned

Parameters:

input - iterator of input elements

transformer - a transformer to apply for each input element before copying to the output

strategy - a strategy determining the type of output collection

Returns:

an empty collection of type T2 or a collection of type T2 with transformed objects from the input collection

Throws:

NullPointerException - if input, transformer, or strategy was null

transform

default <T1,T2,T3 extends T1,S extends Collection<T2>> S transform(Iterator<T3> input,
                                                                   Transformer<T1,T2> transformer,
                                                                   Predicate<T3> predicate,
                                                                   IsCollectionStrategy<S,T2> strategy)

Converts the input iterator to a collection applying a predicate and a transformation for each input element.

Type Parameters:

T1 - the from/source of the transformer (also the type for the iterator)

T2 - the to/target of the transformer and the type of objects in the return collection

T3 - any type that extends T1 to no limit conversion to a single type

S - the type of collection that should be returned

Parameters:

input - iterator of input elements

transformer - a transformer to apply for each input element before copying to the output

predicate - a predicate to apply before transformation and copy of each input element (ignored if null)

strategy - a strategy determining the type of output collection

Returns:

an empty collection of type T2 or a collection of type T2 with transformed objects from the input collection

Throws:

NullPointerException - if input, transformer, or strategy was null

transform

default <T1,T2,T3 extends T1,S extends Collection<T2>> S transform(T3[] input,
                                                                   Transformer<T1,T2> transformer,
                                                                   IsCollectionStrategy<S,T2> strategy)

Converts the input array to a collection applying a transformation for each input element.

Type Parameters:

T1 - the from/source of the transformer (also the type for the array)

T2 - the to/target of the transformer and the type of objects in the return collection

T3 - any type that extends T1 to no limit conversion to a single type

S - the type of collection that should be returned

Parameters:

input - array of input elements

transformer - a transformer to apply for each input element before copying to the output

strategy - a strategy determining the type of output collection

Returns:

an empty collection of type T2 or a collection of type T2 with transformed objects from the input collection

Throws:

NullPointerException - if input, transformer, or strategy was null

transform

default <T1,T2,T3 extends T1,S extends Collection<T2>> S transform(T3[] input,
                                                                   Transformer<T1,T2> transformer,
                                                                   Predicate<T3> predicate,
                                                                   IsCollectionStrategy<S,T2> strategy)

Converts the input array to a collection applying a predicate and a transformation for each input element.

Type Parameters:

T1 - the from/source of the transformer (also the type for the array)

T2 - the to/target of the transformer and the type of objects in the return collection

T3 - any type that extends T1 to no limit conversion to a single type

S - the type of collection that should be returned

Parameters:

input - array of input elements

transformer - a transformer to apply for each input element before copying to the output

predicate - a predicate to apply before transformation and copy of each input element (ignored if null)

strategy - a strategy determining the type of output collection

Returns:

an empty collection of type T2 or a collection of type T2 with transformed objects from the input collection

Throws:

NullPointerException - if input, transformer, or strategy was null

create

static ClusterElementTransformer create()

Creates a new transformer.

Returns:

new transformer