com.github.dozermapper.core

Class DozerBeanMapper

java.lang.Object

com.github.dozermapper.core.DozerBeanMapper

All Implemented Interfaces:

Mapper, MapperModelContext

public class DozerBeanMapper
extends Object
implements Mapper, MapperModelContext

Public Dozer Mapper implementation. This should be used/defined as a singleton within your application. This class performs several one-time initializations and loads the custom xml mappings, so you will not want to create many instances of it for performance reasons. Typically a system will only have one DozerBeanMapper instance per VM. If you are using an IOC framework (i.e Spring), define the Mapper as singleton="true". If you are not using an IOC framework, a DozerBeanMapperSingletonWrapper convenience class has been provided in the Dozer jar.

It is technically possible to have multiple DozerBeanMapper instances initialized, but it will hinder internal performance optimizations such as caching.

Method Summary

Modifier and Type	Method and Description
List<CustomConverter>	getCustomConverters() Returns a list of registered CustomConverter
Map<String,CustomConverter>	getCustomConvertersWithId() Returns a list of registered CustomConverter which can be referenced in mapping by provided ID.
CustomFieldMapper	getCustomFieldMapper() Returns a list of registered CustomFieldMapper
List<? extends EventListener>	getEventListeners() Returns a list of registered EventListener
MapperModelContext	getMapperModelContext() Returns MapperModelContext which allows readonly access to the Mapper model
List<String>	getMappingFiles() Returns list of provided mapping file URLs
MappingMetadata	getMappingMetadata() The MappingMetadata interface can be used to query information about the current mapping definitions.
protected Mapper	getMappingProcessor()
<T> T	map(Object source, Class<T> destinationClass) Constructs new instance of destinationClass and performs mapping between from source
<T> T	map(Object source, Class<T> destinationClass, String mapId) Constructs new instance of destinationClass and performs mapping between from source
void	map(Object source, Object destination) Performs mapping between source and destination objects
void	map(Object source, Object destination, String mapId) Performs mapping between source and destination objects

Methods inherited from class java.lang.Object

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

Method Detail

map

public void map(Object source,
                Object destination,
                String mapId)
         throws MappingException

Performs mapping between source and destination objects

Specified by:

map in interface Mapper

Parameters:

source - object to convert from

destination - object to convert to

mapId - id in configuration for mapping

Throws:

MappingException - mapping failure

map

public <T> T map(Object source,
                 Class<T> destinationClass,
                 String mapId)
          throws MappingException

Constructs new instance of destinationClass and performs mapping between from source

Specified by:

map in interface Mapper

Type Parameters:

T - type to convert to

Parameters:

source - object to convert from

destinationClass - type to convert to

mapId - id in configuration for mapping

Returns:

mapped object

Throws:

MappingException - mapping failure

map

public <T> T map(Object source,
                 Class<T> destinationClass)
          throws MappingException

Constructs new instance of destinationClass and performs mapping between from source

Specified by:

map in interface Mapper

Type Parameters:

T - type to convert to

Parameters:

source - object to convert from

destinationClass - type to convert to

Returns:

mapped object

Throws:

MappingException - mapping failure

map

public void map(Object source,
                Object destination)
         throws MappingException

Performs mapping between source and destination objects

Specified by:

map in interface Mapper

Parameters:

source - object to convert from

destination - object to convert to

Throws:

MappingException - mapping failure

getMappingProcessor

protected Mapper getMappingProcessor()

getMappingMetadata

public MappingMetadata getMappingMetadata()

The MappingMetadata interface can be used to query information about the current mapping definitions. It provides read only access to all important classes and field mapping properties. When first called, initializes all mappings if map() has not yet been called.

Specified by:

getMappingMetadata in interface Mapper

Returns:

An instance of MappingMetadata which serves starting point for querying mapping information.

getMapperModelContext

public MapperModelContext getMapperModelContext()

Returns MapperModelContext which allows readonly access to the Mapper model

Specified by:

getMapperModelContext in interface Mapper

Returns:

an instance of MapperModelContext

getMappingFiles

public List<String> getMappingFiles()

Returns list of provided mapping file URLs

Specified by:

getMappingFiles in interface MapperModelContext

Returns:

unmodifiable list of mapping files

getCustomConverters

public List<CustomConverter> getCustomConverters()

Returns a list of registered CustomConverter

Specified by:

getCustomConverters in interface MapperModelContext

Returns:

unmodifiable list of converters

getCustomConvertersWithId

public Map<String,CustomConverter> getCustomConvertersWithId()

Returns a list of registered CustomConverter which can be referenced in mapping by provided ID.

Specified by:

getCustomConvertersWithId in interface MapperModelContext

Returns:

unmodifiable list of converters

getEventListeners

public List<? extends EventListener> getEventListeners()

Returns a list of registered EventListener

Specified by:

getEventListeners in interface MapperModelContext

Returns:

unmodifiable list of listeners

getCustomFieldMapper

public CustomFieldMapper getCustomFieldMapper()

Returns a list of registered CustomFieldMapper

Specified by:

getCustomFieldMapper in interface MapperModelContext

Returns:

a custom field mapper