com.github.dozermapper.core

Interface Mapper

All Known Implementing Classes:

DozerBeanMapper, MappingProcessor

public interface Mapper

Public root interface for performing Dozer mappings from application code.

Method Summary

Modifier and Type	Method and Description
MapperModelContext	getMapperModelContext() Returns MapperModelContext which allows readonly access to the Mapper model
default MappingMetadata	getMappingMetadata() The MappingMetadata interface can be used to query information about the current mapping definitions.
<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

Method Detail

map

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

Constructs new instance of destinationClass and performs mapping between from source

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

void map(Object source,
         Object destination)
  throws MappingException

Performs mapping between source and destination objects

Parameters:

source - object to convert from

destination - object to convert to

Throws:

MappingException - mapping failure

map

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

Constructs new instance of destinationClass and performs mapping between from source

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

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

Performs mapping between source and destination objects

Parameters:

source - object to convert from

destination - object to convert to

mapId - id in configuration for mapping

Throws:

MappingException - mapping failure

getMappingMetadata

default 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.

Returns:

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

getMapperModelContext

MapperModelContext getMapperModelContext()

Returns MapperModelContext which allows readonly access to the Mapper model

Returns:

an instance of MapperModelContext