com.github.erchu.beancp

Class MapperBuilder

java.lang.Object

com.github.erchu.beancp.MapperBuilder

All Implemented Interfaces:

MappingInfo

public final class MapperBuilder
extends Object
implements MappingInfo

Builds mapper implementation. This class do not guarantee to be thread-safe.

Constructor Summary

Constructors

Constructor and Description
MapperBuilder()

Method Summary

Modifier and Type	Method and Description
<S,D> MapperBuilder	addConverter(Class<S> sourceClass, Class<D> destinationClass, java.util.function.BiFunction<Mapper,S,D> convertionAction) Adds new mapping implemented by converter.
<S,D> MapperBuilder	addConverter(Class<S> sourceClass, Class<D> destinationClass, java.util.function.Function<S,D> convertionAction) Adds new mapping implemented by converter.
MapperBuilder	addConverter(Converter<?,?>... converters) Adds new mapping implemented by converters.
<S,D> MapperBuilder	addMap(Class<S> sourceClass, Class<D> destinationClass, DeclarativeMapSetup<S,D> mapConfiguration) Adds new mapping defined by map.
MapperBuilder	addMapAnyByConvention(MapConvention... conventions) If two data types has no mapping defined by addMap(java.lang.Class, java.lang.Class, com.github.erchu.beancp.DeclarativeMapSetup) or any of addConverter methods then this convention will be used.
Mapper	buildMapper() Creates map implementation from definitions.
boolean	isConverterAvailable(Class sourceClass, Class destinationClass) Returns true if converter is available, false otherwise.
boolean	isMapAvailable(Class sourceClass, Class destinationClass) Returns true if map (or map convention) is available, false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapperBuilder

public MapperBuilder()

Method Detail

addMap

public <S,D> MapperBuilder addMap(Class<S> sourceClass,
                                  Class<D> destinationClass,
                                  DeclarativeMapSetup<S,D> mapConfiguration)
                           throws MapperConfigurationException

Adds new mapping defined by map. Both source and destination classes must:

• Must have default public constructor or have not been final and have default protected constructor. This requirement is valid even if destination object builder is provided by DeclarativeMap.constructDestinationObjectUsing(java.util.function.Supplier) method.
• Cannot be inner non-static classes.

Type Parameters:

S - source object class.

D - destination object class.

Parameters:

sourceClass - source object class.

destinationClass - destination object class.

mapConfiguration - map configuration.

Returns:

this (for method chaining)

Throws:

MapperConfigurationException

addConverter

public <S,D> MapperBuilder addConverter(Class<S> sourceClass,
                                        Class<D> destinationClass,
                                        java.util.function.Function<S,D> convertionAction)
                                 throws MapperConfigurationException

Adds new mapping implemented by converter.

Type Parameters:

S - source object class.

D - destination object class.

Parameters:

sourceClass - source object class.

destinationClass - destination object class.

convertionAction - converter action, must be thread-safe.

Returns:

this (for method chaining)

Throws:

MapperConfigurationException

addConverter

public <S,D> MapperBuilder addConverter(Class<S> sourceClass,
                                        Class<D> destinationClass,
                                        java.util.function.BiFunction<Mapper,S,D> convertionAction)
                                 throws MapperConfigurationException

Adds new mapping implemented by converter.

Type Parameters:

S - source object class.

D - destination object class.

Parameters:

sourceClass - source object class.

destinationClass - destination object class.

convertionAction - converter action, must be thread-safe.

Returns:

this (for method chaining)

Throws:

MapperConfigurationException

addConverter

public MapperBuilder addConverter(Converter<?,?>... converters)
                           throws MapperConfigurationException

Adds new mapping implemented by converters.

Parameters:

converters - converters to add.

Returns:

this (for method chaining)

Throws:

MapperConfigurationException

addMapAnyByConvention

public MapperBuilder addMapAnyByConvention(MapConvention... conventions)
                                    throws MapperConfigurationException

If two data types has no mapping defined by addMap(java.lang.Class, java.lang.Class, com.github.erchu.beancp.DeclarativeMapSetup) or any of addConverter methods then this convention will be used.

Parameters:

conventions - convention to add.

Returns:

this (for method chaining)

Throws:

MapperConfigurationException

buildMapper

public Mapper buildMapper()

Creates map implementation from definitions. After executed no other methods can be executed on this instance.

Returns:

map implementation.

isMapAvailable

public boolean isMapAvailable(Class sourceClass,
                              Class destinationClass)

Description copied from interface: MappingInfo

Returns true if map (or map convention) is available, false otherwise.

Specified by:

isMapAvailable in interface MappingInfo

Parameters:

sourceClass - source object class.

destinationClass - destination object class.

Returns:

true if map (or map convention) is available, false otherwise.

isConverterAvailable

public boolean isConverterAvailable(Class sourceClass,
                                    Class destinationClass)

Description copied from interface: MappingInfo

Returns true if converter is available, false otherwise.

Specified by:

isConverterAvailable in interface MappingInfo

Parameters:

sourceClass - source object class.

destinationClass - destination object class.

Returns:

true if converter is available, false otherwise.