com.github.erchu.beancp

Interface Mapper

All Superinterfaces:

MappingInfo

public interface Mapper
extends MappingInfo

Object to object mapper. Implementation must be thread-safe.

Method Summary

Modifier and Type	Method and Description
<S,D> D	map(S source, Class<D> destinationClass) Constructs destination object and copies data from source object to newly created destination object.
<S,D> void	map(S source, D destination) Copies data from source object to destination object.
<S,D> Optional<D>	mapIfMapperAvailable(S source, Class<D> destinationClass) Constructs destination object and copies data from source object to newly created destination object.
<S,D> boolean	mapIfMapperAvailable(S source, D destination) Copies data from source object to destination object.

Methods inherited from interface com.github.erchu.beancp.MappingInfo

isConverterAvailable, isMapAvailable

Method Detail

map

<S,D> void map(S source,
               D destination)
        throws MappingException

Copies data from source object to destination object.

When the are more than one mapper valid for source and destination classes then mapper is chose according to priority (first option has highest priority):

1. source class equals to mapper source class and destination class equals to mapper destination class
2. source class inherits from mapper source class and destination class equals to mapper destination class
3. source class equals to mapper source class and destination class inherits from mapper destination class
4. source class inherits from mapper source class and destination class inherits from mapper destination class
5. convention defined by MapperBuilder.addMapAnyByConvention(com.github.erchu.beancp.MapConvention...)

When there is more than one mapper of the same priority then is used the first one added to MapperBuilder. If no mapper available then MappingException will be thrown.

Circular references will result in stack overflow.

Type Parameters:

S - source object class.

D - destination object class.

Parameters:

source - source object.

destination - destination object.

Throws:

MappingException

mapIfMapperAvailable

<S,D> boolean mapIfMapperAvailable(S source,
                                   D destination)
                            throws MappingException

Copies data from source object to destination object.

When the are more than one mapper valid for source and destination classes then mapper is chose according to priority (first option has highest priority):

1. source class equals to mapper source class and destination class equals to mapper destination class
2. source class inherits from mapper source class and destination class equals to mapper destination class
3. source class equals to mapper source class and destination class inherits from mapper destination class
4. source class inherits from mapper source class and destination class inherits from mapper destination class
5. convention defined by MapperBuilder.addMapAnyByConvention(com.github.erchu.beancp.MapConvention...)

When there is more than one mapper of the same priority then is used the first one added to MapperBuilder. If no mapper available then will return false{code}, otherwise return true{code}.

Circular references will result in stack overflow.

Type Parameters:

S - source object class.

D - destination object class.

Parameters:

source - source object.

destination - destination object.

Returns:

false{code} if no mapper available, otherwise true{code}.

Throws:

MappingException

map

<S,D> D map(S source,
            Class<D> destinationClass)
     throws MappingException

Constructs destination object and copies data from source object to newly created destination object. Destination object is created by destination object builder defined by DeclarativeMap.constructDestinationObjectUsing(java.util.function.Supplier) or if destination object builder is not available by default constructor.

When the are more than one mapper valid for source and destination classes then mapper is chose according to priority (first option has highest priority):

1. source class equals to mapper source class and destination class equals to mapper destination class
2. source class inherits from mapper source class and destination class equals to mapper destination class
3. source class equals to mapper source class and destination class inherits from mapper destination class
4. source class inherits from mapper source class and destination class inherits from mapper destination class
5. convention defined by MapperBuilder.addMapAnyByConvention(com.github.erchu.beancp.MapConvention...)

When there is more than one mapper of the same priority then is used the first one added to MapperBuilder. If no mapper available then MappingException will be thrown.

Circular references will result in stack overflow.

Type Parameters:

S - source object class.

D - destination object class.

Parameters:

source - source object.

destinationClass - destination object class.

Returns:

destination object.

Throws:

MappingException

mapIfMapperAvailable

<S,D> Optional<D> mapIfMapperAvailable(S source,
                                       Class<D> destinationClass)
                                throws MappingException

Constructs destination object and copies data from source object to newly created destination object. Destination object is created by destination object builder defined by DeclarativeMap.constructDestinationObjectUsing(java.util.function.Supplier) or if destination object builder is not available by default constructor.

When the are more than one mapper valid for source and destination classes then mapper is chose according to priority (first option has highest priority):

1. source class equals to mapper source class and destination class equals to mapper destination class
2. source class inherits from mapper source class and destination class equals to mapper destination class
3. source class equals to mapper source class and destination class inherits from mapper destination class
4. source class inherits from mapper source class and destination class inherits from mapper destination class
5. convention defined by MapperBuilder.addMapAnyByConvention(com.github.erchu.beancp.MapConvention...)

When there is more than one mapper of the same priority then is used the first one added to MapperBuilder.

Circular references will result in stack overflow.

Type Parameters:

S - source object class.

D - destination object class.

Parameters:

source - source object.

destinationClass - destination object class.

Returns:

destination object if no mapper is available, otherwise empty optional object.

Throws:

MappingException