com.github.dozermapper.core.builder.model.jaxb

Class FieldDefinition

java.lang.Object

com.github.dozermapper.core.builder.model.jaxb.FieldDefinition

Direct Known Subclasses:

ELFieldDefinition

public class FieldDefinition
extends Object

Specifies a custom field mapping. Fields that share the same attribute name do not need to be defined. Dozer automatically maps fields that match on attribute name. All Field Mapping definitions are bi-directional by default. Global configuration, Mapping, and ClassDefinition element values are inherited.

Hints are used for mapping Collection types. A hint indicates which type of destination object should be created and added to the destination Collection.

Required Attributes:

Optional Attributes:

relationship-type For collections, indicates whether to add to existing values or to always replace any existing entries

remove-orphans For collections, indicates whether items that did not exist in the source collection should be removed from the destination collection.

type Indicates whether this mapping is bi-directional or only one-way. Typically this will be set to bi-directional. The default is "bi-directional".

map-id The id that uniquely identifies this mapping definition. This typically will not be specified. You would only need to specify this for only need this for special context based mapping and when mapping between Map objects and Custom Data Objects.

copy-by-reference Indicates whether the source field value is copied by reference or by value when populating the destination field. The default value is "false"

custom-converter Indicates that a specific custom converter should be used for mapping this field. Typically this will not be specified.

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldDefinitionDefinition	a
protected String	aDeepIndexHint
protected String	aHint
protected FieldDefinitionDefinition	b
protected String	bDeepIndexHint
protected String	bHint
protected Boolean	copyByReference
protected String	customConverter
protected String	customConverterId
protected String	customConverterParam
protected String	mapId
protected Relationship	relationshipType
protected Boolean	removeOrphans
protected Type	type

Constructor Summary

Constructors

Constructor and Description
FieldDefinition()
FieldDefinition(MappingDefinition parentMappingDefinition)

Method Summary

Modifier and Type	Method and Description
FieldMap	build(ClassMap classMap, BeanContainer beanContainer, DestBeanCreator destBeanCreator, PropertyDescriptorFactory propertyDescriptorFactory)
MappingDefinition	end()
FieldDefinitionDefinition	withA()
FieldDefinition	withADeepIndexHint(String aDeepIndexHint)
FieldDefinition	withAHint(String aHint)
FieldDefinitionDefinition	withB()
FieldDefinition	withBDeepIndexHint(String bDeepIndexHint)
FieldDefinition	withBHint(String bHint)
FieldDefinition	withCopyByReference(Boolean copyByReference)
FieldDefinition	withCustomConverter(String customConverter)
FieldDefinition	withCustomConverterId(String customConverterId)
FieldDefinition	withCustomConverterParam(String customConverterParam)
FieldDefinition	withMapId(String mapId)
FieldDefinition	withRelationshipType(Relationship relationshipType)
FieldDefinition	withRemoveOrphans(Boolean removeOrphans)
FieldDefinition	withType(Type type)

Methods inherited from class java.lang.Object

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

Field Detail

a

protected FieldDefinitionDefinition a

b

protected FieldDefinitionDefinition b

aHint

protected String aHint

bHint

protected String bHint

aDeepIndexHint

protected String aDeepIndexHint

bDeepIndexHint

protected String bDeepIndexHint

relationshipType

protected Relationship relationshipType

removeOrphans

protected Boolean removeOrphans

type

protected Type type

mapId

protected String mapId

copyByReference

protected Boolean copyByReference

customConverter

protected String customConverter

customConverterId

protected String customConverterId

customConverterParam

protected String customConverterParam

Constructor Detail

FieldDefinition

public FieldDefinition()

FieldDefinition

public FieldDefinition(MappingDefinition parentMappingDefinition)

Method Detail

withA

public FieldDefinitionDefinition withA()

withB

public FieldDefinitionDefinition withB()

withAHint

public FieldDefinition withAHint(String aHint)

withBHint

public FieldDefinition withBHint(String bHint)

withADeepIndexHint

public FieldDefinition withADeepIndexHint(String aDeepIndexHint)

withBDeepIndexHint

public FieldDefinition withBDeepIndexHint(String bDeepIndexHint)

withRelationshipType

public FieldDefinition withRelationshipType(Relationship relationshipType)

withRemoveOrphans

public FieldDefinition withRemoveOrphans(Boolean removeOrphans)

withType

public FieldDefinition withType(Type type)

withMapId

public FieldDefinition withMapId(String mapId)

withCopyByReference

public FieldDefinition withCopyByReference(Boolean copyByReference)

withCustomConverter

public FieldDefinition withCustomConverter(String customConverter)

withCustomConverterId

public FieldDefinition withCustomConverterId(String customConverterId)

withCustomConverterParam

public FieldDefinition withCustomConverterParam(String customConverterParam)

end

public MappingDefinition end()

build

public FieldMap build(ClassMap classMap,
                      BeanContainer beanContainer,
                      DestBeanCreator destBeanCreator,
                      PropertyDescriptorFactory propertyDescriptorFactory)