org.codefx.libfx.collection.transform

Class TransformingCollectionBuilder<I,O>

java.lang.Object

org.codefx.libfx.collection.transform.TransformingCollectionBuilder<I,O>

Type Parameters:

I - the inner type of the created transforming collection, i.e. the type of the elements contained in the wrapped/inner collection

O - the outer type of the created transforming collection, i.e. the type of elements appearing to be in the created collection

public class TransformingCollectionBuilder<I,O>
extends Object

Builder for TransformingCollections, TransformingSets and TransformingLists.

A builder can be obtained by calling forInnerAndOuterType or forInnerAndOuterTypeUnknown(). The building methods transform... can only be called after transformations from inner to outer elements and vice versa have been set.

Method Summary

Modifier and Type	Method and Description
static <I,O> TransformingCollectionBuilder<I,O>	forInnerAndOuterType(Class<? super I> innerTypeToken, Class<? super O> outerTypeToken) Returns a new builder for the specified inner and outer type.
static <I,O> TransformingCollectionBuilder<I,O>	forInnerAndOuterTypeUnknown() Returns a new builder for unknown inner and outer types.
TransformingCollectionBuilder<I,O>	toInner(Function<? super O,? extends I> transformToInner) Sets the transformation from outer to inner elements which will be used by the created collection.
TransformingCollectionBuilder<I,O>	toOuter(Function<? super I,? extends O> transformToOuter) Sets the transformation from inner to outer elements which will be used by the created collection.
TransformingCollection<I,O>	transformCollection(Collection<I> collection) Creates a TransformingCollection which transforms/decorates the specified collection.
TransformingList<I,O>	transformList(List<I> list) Creates a TransformingList which transforms/decorates the specified list.
TransformingSet<I,O>	transformSet(Set<I> set) Creates a TransformingSet which transforms/decorates the specified set.

Methods inherited from class java.lang.Object

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

Method Detail

forInnerAndOuterType

public static <I,O> TransformingCollectionBuilder<I,O> forInnerAndOuterType(Class<? super I> innerTypeToken,
                                                                            Class<? super O> outerTypeToken)

Returns a new builder for the specified inner and outer type.

Type Parameters:

I - the inner type of the created transforming collection, i.e. the type of the elements contained in the wrapped/inner collection

O - the outer type of the created transforming collection, i.e. the type of elements appearing to be in the created collection

Parameters:

innerTypeToken - the token for the inner type

outerTypeToken - the token for the outer type

Returns:

a new builder

forInnerAndOuterTypeUnknown

public static <I,O> TransformingCollectionBuilder<I,O> forInnerAndOuterTypeUnknown()

Returns a new builder for unknown inner and outer types.

This is equivalent to calling forInnerAndOuterType(Object.class, Object.class). To obtain a builder for <I, O> you will have to call TransformingCollectionBuilder.<I, O> forInnerAndOuterTypeUnknown().

Type Parameters:

I - the inner type of the created transforming collection, i.e. the type of the elements contained in the wrapped/inner collection

O - the outer type of the created transforming collection, i.e. the type of elements appearing to be in the created collection

Returns:

a new builder

toOuter

public TransformingCollectionBuilder<I,O> toOuter(Function<? super I,? extends O> transformToOuter)

Sets the transformation from inner to outer elements which will be used by the created collection.

Parameters:

transformToOuter - transforms inner to outer elements

Returns:

this builder

toInner

public TransformingCollectionBuilder<I,O> toInner(Function<? super O,? extends I> transformToInner)

Sets the transformation from outer to inner elements which will be used by the created collection.

Parameters:

transformToInner - transforms outer to inner elements

Returns:

this builder

transformCollection

public TransformingCollection<I,O> transformCollection(Collection<I> collection)

Creates a TransformingCollection which transforms/decorates the specified collection.

Parameters:

collection - the collection to transform; will be the inner collection of the returned transformation

Returns:

a new TransformingCollection

transformSet

public TransformingSet<I,O> transformSet(Set<I> set)

Creates a TransformingSet which transforms/decorates the specified set.

Parameters:

set - the set to transform; will be the inner set of the returned transformation

Returns:

a new TransformingSet

transformList

public TransformingList<I,O> transformList(List<I> list)

Creates a TransformingList which transforms/decorates the specified list.

Parameters:

list - the list to transform; will be the inner list of the returned transformation

Returns:

a new TransformingList