com.github.erchu.beancp

Interface DeclarativeMap<S,D>

Type Parameters:

S - source class

D - destination class

public interface DeclarativeMap<S,D>

Defines mapping between source and destination class. Source and destination classes must have default public or private constructor. Interface methods must be executed in following order:

1. constructDestinationObjectUsing(java.util.function.Supplier) zero or one time
2. beforeMap(com.github.erchu.beancp.Action) zero or many times
3. useConvention(com.github.erchu.beancp.MapConvention) zero or one time
4. bind(java.util.function.Supplier, java.util.function.Consumer, com.github.erchu.beancp.BindingOption...), bindConstant(java.lang.Object, java.util.function.Consumer, com.github.erchu.beancp.BindingOption...), mapInner(java.util.function.Supplier, java.util.function.Consumer, java.lang.Class, com.github.erchu.beancp.BindingOption[]) and mapInner(java.util.function.Supplier, java.util.function.Consumer, java.util.function.Supplier, java.lang.Class, com.github.erchu.beancp.BindingOption[]) methods zero or many times in any order
5. afterMap(com.github.erchu.beancp.Action) zero or many times

Method Summary

Modifier and Type	Method and Description
DeclarativeMap<S,D>	afterMap(Action action) Action to be performed before mappings.
DeclarativeMap<S,D>	afterMap(java.util.function.Consumer<Mapper> action) Action to be performed before mappings.
DeclarativeMap<S,D>	beforeMap(Action action) Action to be performed after mappings.
DeclarativeMap<S,D>	beforeMap(java.util.function.Consumer<Mapper> action) Action to be performed after mappings.
<T> DeclarativeMap<S,D>	bind(java.util.function.Supplier<T> fromFunction, java.util.function.Consumer<T> toMember, BindingOption<S,D,T>... options) Adds calculated member binding to destination member or members.
<T> DeclarativeMap<S,D>	bindConstant(T constantValue, java.util.function.Consumer<T> toMember, BindingOption<S,D,T>... options) Adds constant binding to destination member or members.
DeclarativeMap<S,D>	constructDestinationObjectUsing(java.util.function.Supplier<D> destinationObjectBuilder) Operation used to build destination object.
<SI,DI> DeclarativeMap<S,D>	mapInner(java.util.function.Supplier<SI> fromFunction, java.util.function.Consumer<DI> toMember, Class<DI> toMemberClass, BindingOption<S,D,DI>... options) Adds inner object mapping.
<SI,DI> DeclarativeMap<S,D>	mapInner(java.util.function.Supplier<SI> fromFunction, java.util.function.Consumer<DI> toMember, java.util.function.Supplier<DI> toMemberGetter, Class<DI> toMemberClass, BindingOption<S,D,DI>... options) Adds inner object mapping.
DeclarativeMap<S,D>	useConvention(MapConvention MapConvention) Adds mappings using convention.

Method Detail

constructDestinationObjectUsing

DeclarativeMap<S,D> constructDestinationObjectUsing(java.util.function.Supplier<D> destinationObjectBuilder)

Operation used to build destination object. Must be thread-safe.

Parameters:

destinationObjectBuilder - destination object builder, must be thread-safe.

Returns:

this (for method chaining)

beforeMap

DeclarativeMap<S,D> beforeMap(Action action)

Action to be performed after mappings. Must be thread-safe.

Parameters:

action - action to be executed after mappings, must be thread-safe.

Returns:

this (for method chaining)

beforeMap

DeclarativeMap<S,D> beforeMap(java.util.function.Consumer<Mapper> action)

Action to be performed after mappings. Must be thread-safe.

Parameters:

action - action to be executed after mappings, must be thread-safe.

Returns:

this (for method chaining)

useConvention

DeclarativeMap<S,D> useConvention(MapConvention MapConvention)

Adds mappings using convention. Convention mappings are performed before other mappings defined by bind(java.util.function.Supplier, java.util.function.Consumer, com.github.erchu.beancp.BindingOption...) and bindConstant(java.lang.Object, java.util.function.Consumer, com.github.erchu.beancp.BindingOption...).

Parameters:

MapConvention - convention to use. Must be thread-safe.

Returns:

this (for method chaining)

bind

<T> DeclarativeMap<S,D> bind(java.util.function.Supplier<T> fromFunction,
                             java.util.function.Consumer<T> toMember,
                             BindingOption<S,D,T>... options)

Adds calculated member binding to destination member or members. Must be thread-safe.

Type Parameters:

T - value data type

Parameters:

fromFunction - calculated member function, must be thread-safe.

toMember - destination class member, must be thread-safe.

options - additional mapping options

Returns:

this (for method chaining)

bindConstant

<T> DeclarativeMap<S,D> bindConstant(T constantValue,
                                     java.util.function.Consumer<T> toMember,
                                     BindingOption<S,D,T>... options)

Adds constant binding to destination member or members. Must be thread-safe.

Type Parameters:

T - value data type

Parameters:

constantValue - constant value

toMember - destination class member, must be thread-safe.

options - additional mapping options

Returns:

this (for method chaining)

mapInner

<SI,DI> DeclarativeMap<S,D> mapInner(java.util.function.Supplier<SI> fromFunction,
                                     java.util.function.Consumer<DI> toMember,
                                     java.util.function.Supplier<DI> toMemberGetter,
                                     Class<DI> toMemberClass,
                                     BindingOption<S,D,DI>... options)

Adds inner object mapping. Must be thread-safe.

Type Parameters:

SI - source value data type

DI - destination value data type

Parameters:

fromFunction - calculated member function, must be thread-safe.

toMember - destination class member setter, must be thread-safe.

toMemberGetter - destination class member get, must be thread-safe.

toMemberClass - destination class member type

options - additional mapping options

Returns:

this (for method chaining)

mapInner

<SI,DI> DeclarativeMap<S,D> mapInner(java.util.function.Supplier<SI> fromFunction,
                                     java.util.function.Consumer<DI> toMember,
                                     Class<DI> toMemberClass,
                                     BindingOption<S,D,DI>... options)

Adds inner object mapping. Must be thread-safe.

Type Parameters:

SI - source value data type

DI - destination value data type

Parameters:

fromFunction - calculated member function, must be thread-safe.

toMember - destination class member setter, must be thread-safe.

toMemberClass - destination class member type

options - additional mapping options

Returns:

this (for method chaining)

afterMap

DeclarativeMap<S,D> afterMap(Action action)

Action to be performed before mappings. Must be thread-safe.

Parameters:

action - action to be executed before mappings, must be thread-safe.

Returns:

this (for method chaining)

afterMap

DeclarativeMap<S,D> afterMap(java.util.function.Consumer<Mapper> action)

Action to be performed before mappings. Must be thread-safe.

Parameters:

action - action to be executed before mappings, must be thread-safe.

Returns:

this (for method chaining)