org.codefx.libfx.collection.transform

Class TransformingMapBuilder<IK,OK,IV,OV>

java.lang.Object

org.codefx.libfx.collection.transform.TransformingMapBuilder<IK,OK,IV,OV>

Type Parameters:

IK - the inner key type of the created transforming map, i.e. the type of the keys contained in the wrapped/inner map

OK - the outer key type of the created transforming map, i.e. the type of keys appearing to be in this map

IV - the inner value type of the created transforming map, i.e. the type of the values contained in the wrapped/inner map

OV - the outer value type of the created transforming map, i.e. the type of values appearing to be in this map

public class TransformingMapBuilder<IK,OK,IV,OV>
extends Object

Builder for TransformingMaps.

A builder can be obtained by calling forTypes or forTypesUnknown(). The building method TODO can only be called after transformations from inner to outer keys and values and vice versa have been set.

Method Summary

Modifier and Type	Method and Description
static <IK,OK,IV,OV> TransformingMapBuilder<IK,OK,IV,OV>	forTypes(Class<? super IK> innerKeyTypeToken, Class<? super OK> outerKeyTypeToken, Class<? super IV> innerValueTypeToken, Class<? super OV> outerValueTypeToken) Returns a new builder for the specified inner and outer key and value types.
static <IK,OK,IV,OV> TransformingMapBuilder<IK,OK,IV,OV>	forTypesUnknown() Returns a new builder for unknown inner and outer key and value types.
TransformingMapBuilder<IK,OK,IV,OV>	toInnerKey(Function<? super OK,? extends IK> transformToInnerKey) Sets the transformation from outer to inner keys which will be used by the created map.
TransformingMapBuilder<IK,OK,IV,OV>	toInnerValue(Function<? super OV,? extends IV> transformToInnerValue) Sets the transformation from outer to inner values which will be used by the created map.
TransformingMapBuilder<IK,OK,IV,OV>	toOuterKey(Function<? super IK,? extends OK> transformToOuterKey) Sets the transformation from inner to outer keys which will be used by the created map.
TransformingMapBuilder<IK,OK,IV,OV>	toOuterValue(Function<? super IV,? extends OV> transformToOuterValue) Sets the transformation from inner to outer values which will be used by the created map.
TransformingMap<IK,OK,IV,OV>	transformMap(Map<IK,IV> map) Creates a TransformingMap which transforms/decorates the specified map.

Methods inherited from class java.lang.Object

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

Method Detail

forTypes

public static <IK,OK,IV,OV> TransformingMapBuilder<IK,OK,IV,OV> forTypes(Class<? super IK> innerKeyTypeToken,
                                                                         Class<? super OK> outerKeyTypeToken,
                                                                         Class<? super IV> innerValueTypeToken,
                                                                         Class<? super OV> outerValueTypeToken)

Returns a new builder for the specified inner and outer key and value types.

Type Parameters:

IK - the inner key type of the created transforming map, i.e. the type of the keys contained in the wrapped/inner map

OK - the outer key type of the created transforming map, i.e. the type of keys appearing to be in this map

IV - the inner value type of the created transforming map, i.e. the type of the values contained in the wrapped/inner map

OV - the outer value type of the created transforming map, i.e. the type of values appearing to be in this map

Parameters:

innerKeyTypeToken - the token for the inner key type

outerKeyTypeToken - the token for the outer key type

innerValueTypeToken - the token for the inner value type

outerValueTypeToken - the token for the outer value type

Returns:

a new builder

forTypesUnknown

public static <IK,OK,IV,OV> TransformingMapBuilder<IK,OK,IV,OV> forTypesUnknown()

Returns a new builder for unknown inner and outer key and value types.

This is equivalent to calling forTypes(Object.class, Object.class, Object.class, Object.class). To obtain a builder for <IK, OK, IV, OV> you will have to call TransformingMapBuilder.<IK, OK, IV, OV> forTypesUnknown().

Type Parameters:

IK - the inner key type of the created transforming map, i.e. the type of the keys contained in the wrapped/inner map

OK - the outer key type of the created transforming map, i.e. the type of keys appearing to be in this map

IV - the inner value type of the created transforming map, i.e. the type of the values contained in the wrapped/inner map

OV - the outer value type of the created transforming map, i.e. the type of values appearing to be in this map

Returns:

a new builder

toOuterKey

public TransformingMapBuilder<IK,OK,IV,OV> toOuterKey(Function<? super IK,? extends OK> transformToOuterKey)

Sets the transformation from inner to outer keys which will be used by the created map.

Parameters:

transformToOuterKey - transforms inner to outer keys

Returns:

this builder

toInnerKey

public TransformingMapBuilder<IK,OK,IV,OV> toInnerKey(Function<? super OK,? extends IK> transformToInnerKey)

Sets the transformation from outer to inner keys which will be used by the created map.

Parameters:

transformToInnerKey - transforms outer to inner keys

Returns:

this builder

toOuterValue

public TransformingMapBuilder<IK,OK,IV,OV> toOuterValue(Function<? super IV,? extends OV> transformToOuterValue)

Sets the transformation from inner to outer values which will be used by the created map.

Parameters:

transformToOuterValue - transforms inner to outer values

Returns:

this builder

toInnerValue

public TransformingMapBuilder<IK,OK,IV,OV> toInnerValue(Function<? super OV,? extends IV> transformToInnerValue)

Sets the transformation from outer to inner values which will be used by the created map.

Parameters:

transformToInnerValue - transforms outer to inner values

Returns:

this builder

transformMap

public TransformingMap<IK,OK,IV,OV> transformMap(Map<IK,IV> map)

Creates a TransformingMap which transforms/decorates the specified map.

Parameters:

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

Returns:

a new TransformingMap