io.beanmapper

Class BeanMapper

java.lang.Object

io.beanmapper.BeanMapper

public class BeanMapper
extends Object

Class that is responsible first for understanding the semantics of the source and target objects. Once that has been determined, the applicable properties will be copied from source to target.

Constructor Summary

Constructors

Constructor and Description
BeanMapper() Construct a new bean mapper, with default converters.
BeanMapper(boolean includeDefaultConverters) Construct a new bean mapper.

Method Summary

Modifier and Type	Method and Description
void	addConverter(BeanConverter converter) Add a converter class (must inherit from abstract BeanConverter class) to the beanMapper.
void	addPackagePrefix(Class<?> clazz) Adds a package on the basis of a class.
void	addProxySkipClass(Class<?> clazz) Add classes to skip while unproxying to prevent failing of the BeanMapper while mapping proxy classes or classes containing synthetic fields (Like ENUM types).
Object	convert(Object value, Class<?> targetClass) Converts a value into the target class.
<S,T> Collection<T>	map(Collection<S> sourceItems, Class<T> targetClass) Maps a list of source items to a list of target items with a specific class
<S,T> T	map(S source, Class<T> targetClass) Copies the values from the source object to a newly constructed target instance
<S,T> T	map(S source, Class<T> targetClass, BeanInitializer beanInitializer) Copies the values from the source object to a newly constructed target instance
<S,T> T	map(S source, T target) Copies the values from the source object to an existing target instance
void	setBeanInitializer(BeanInitializer beanInitializer)
void	setBeanUnproxy(BeanUnproxy beanUnproxy)

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanMapper

public BeanMapper()

Construct a new bean mapper, with default converters.

BeanMapper

public BeanMapper(boolean includeDefaultConverters)

Construct a new bean mapper.

Parameters:

includeDefaultConverters - whether default converters should be registered

Method Detail

map

public <S,T> T map(S source,
                   Class<T> targetClass)

Copies the values from the source object to a newly constructed target instance

Type Parameters:

S - The instance from which the properties get copied

T - the instance to which the properties get copied

Parameters:

source - source instance of the properties

targetClass - class of the target, needs to be constructed as the target instance

Returns:

the target instance containing all applicable properties

Throws:

BeanMappingException

map

public <S,T> T map(S source,
                   Class<T> targetClass,
                   BeanInitializer beanInitializer)

Copies the values from the source object to a newly constructed target instance

Type Parameters:

S - The instance from which the properties get copied

T - the instance to which the properties get copied

Parameters:

source - source instance of the properties

targetClass - class of the target, needs to be constructed as the target instance

beanInitializer - initializes the beans

Returns:

the target instance containing all applicable properties

Throws:

BeanMappingException

map

public <S,T> Collection<T> map(Collection<S> sourceItems,
                               Class<T> targetClass)

Maps a list of source items to a list of target items with a specific class

Type Parameters:

S - source

T - target

Parameters:

sourceItems - the items to be mapped

targetClass - the class type of the items in the returned list

Returns:

the list of mapped items with class T

Throws:

BeanMappingException

map

public <S,T> T map(S source,
                   T target)

Copies the values from the source object to an existing target instance

Type Parameters:

S - The instance from which the properties get copied.

T - the instance to which the properties get copied

Parameters:

source - source instance of the properties

target - target instance for the properties

Returns:

the original target instance containing all applicable properties

Throws:

BeanMappingException

convert

public Object convert(Object value,
                      Class<?> targetClass)

Converts a value into the target class.

Parameters:

value - the value to convert

targetClass - the target class

Returns:

the converted value

addPackagePrefix

public final void addPackagePrefix(Class<?> clazz)

Adds a package on the basis of a class. All classes in that package and sub-packages are eligible for mapping. The root source and target do not need to be set as such, because the verification is only run against nested classes which should be mapped implicity as well

Parameters:

clazz - the class which sets the package prefix for all mappable classes

addConverter

public final void addConverter(BeanConverter converter)

Add a converter class (must inherit from abstract BeanConverter class) to the beanMapper. On mapping, the beanMapper will check for a suitable converter and use its from and to methods to convert the value of the fields to the correct new data type.

Parameters:

converter - an instance of the class that contains the conversion method implementations and inherits from the abstract BeanConverter class.

addProxySkipClass

public final void addProxySkipClass(Class<?> clazz)

Add classes to skip while unproxying to prevent failing of the BeanMapper while mapping proxy classes or classes containing synthetic fields (Like ENUM types).

Parameters:

clazz - the class that is added to the list of skipped classes

setBeanInitializer

public final void setBeanInitializer(BeanInitializer beanInitializer)

setBeanUnproxy

public final void setBeanUnproxy(BeanUnproxy beanUnproxy)