com.github.dozermapper.core.metadata

Interface FieldMappingMetadata

All Known Implementing Classes:

DozerFieldMappingMetadata

public interface FieldMappingMetadata

This interface can be used to obtain information about the mapping between two fields.

Method Summary

Modifier and Type	Method and Description
String	getCustomConverter() The name of the custom converter class, or an empty string if no custom converter is used.
String	getDateFormat() Gets date format used when mapping
String	getDestinationFieldGetMethod() Gets the destination field get method
String	getDestinationFieldSetMethod() Gets the destination field set method
String	getDestinationName() Gets the destination field name
String	getMapId() Returns the map id of this mapping definition used for contextual mapping selection.
MappingDirection	getMappingDirection() Can be used to check whether a mapping in unidirectional or bidirectional.
String	getSourceFieldGetMethod() Gets the source field get method
String	getSourceFieldSetMethod() Gets the source field set method
String	getSourceName() Gets the source field name
boolean	isCopyByReference() Gets whether mapping should copy by reference
boolean	isDestinationFieldAccessible()
boolean	isSourceFieldAccessible()

Method Detail

getSourceName

String getSourceName()

Gets the source field name

Returns:

The name of the source field.

getDestinationName

String getDestinationName()

Gets the destination field name

Returns:

The name of the destination field.

getSourceFieldGetMethod

String getSourceFieldGetMethod()

Gets the source field get method

Returns:

The name of the getter of the source field.

getSourceFieldSetMethod

String getSourceFieldSetMethod()

Gets the source field set method

Returns:

The name of the setter of the source field.

getDestinationFieldGetMethod

String getDestinationFieldGetMethod()

Gets the destination field get method

Returns:

The name of the getter of the destination field.

getDestinationFieldSetMethod

String getDestinationFieldSetMethod()

Gets the destination field set method

Returns:

The name of the setter of the destination field.

isCopyByReference

boolean isCopyByReference()

Gets whether mapping should copy by reference

Returns:

true if nested objects are copied by reference. false if a deep copy is performed.

isSourceFieldAccessible

boolean isSourceFieldAccessible()

isDestinationFieldAccessible

boolean isDestinationFieldAccessible()

getMappingDirection

MappingDirection getMappingDirection()

Can be used to check whether a mapping in unidirectional or bidirectional.

Returns:

An instance of MappingDirection.

getDateFormat

String getDateFormat()

Gets date format used when mapping

Returns:

The date format used for conversions as a string.

getCustomConverter

String getCustomConverter()

The name of the custom converter class, or an empty string if no custom converter is used.

Returns:

The name of the custom converter class as a string.

getMapId

String getMapId()

Returns the map id of this mapping definition used for contextual mapping selection.

Returns:

The identifier as a string.