org.mapstruct.ap.model

Interface MappingBuilderContext.MappingResolver

All Known Implementing Classes:

MappingResolverImpl

Enclosing class:

MappingBuilderContext

public static interface MappingBuilderContext.MappingResolver

Resolves the most suitable way for mapping an element (property, iterable element etc.) from source to target. There are 2 basic types of mappings:

• conversions
• methods

conversions are essentially one line mappings, such as String to Integer and Integer to Long methods come in some varieties:

• referenced mapping methods, these are methods implemented (or referenced) by the user. Sometimes indicated with the 'uses' in the mapping annotations or part of the abstract mapper class
• generated mapping methods (by means of MapStruct)
• built in methods

Author:

Sjaak Derksen

Method Summary

Modifier and Type	Method and Description
MethodReference	getFactoryMethod(Method mappingMethod, Type target, List<TypeMirror> qualifiers, TypeMirror resultType) returns a no arg factory method
Assignment	getTargetAssignment(Method mappingMethod, String mappedElement, Type sourceType, Type targetType, String targetPropertyName, String dateFormat, List<TypeMirror> qualifiers, TypeMirror resultType, String sourceReference, boolean preferUpdateMethods) returns a parameter assignment
Set<VirtualMappingMethod>	getUsedVirtualMappings()

Method Detail

getTargetAssignment

Assignment getTargetAssignment(Method mappingMethod,
                               String mappedElement,
                               Type sourceType,
                               Type targetType,
                               String targetPropertyName,
                               String dateFormat,
                               List<TypeMirror> qualifiers,
                               TypeMirror resultType,
                               String sourceReference,
                               boolean preferUpdateMethods)

returns a parameter assignment

Parameters:

mappingMethod - target mapping method

mappedElement - used for error messages

sourceType - parameter to match

targetType - return type to match

targetPropertyName - name of the target property

dateFormat - used for formatting dates in build in methods that need context information

qualifiers - used for further select the appropriate mapping method based on class and name

resultType - used for further select the appropriate mapping method based on resultType (bean mapping) targetType (Iterable- and MapMapping)

sourceReference - call to source type as string

preferUpdateMethods - selection should prefer update methods when present.

Returns:

an assignment to a method parameter, which can either be:

1. MethodReference
2. TypeConversion
3. Direct Assignment (empty TargetAssignment)
4. null, no assignment found

getFactoryMethod

MethodReference getFactoryMethod(Method mappingMethod,
                                 Type target,
                                 List<TypeMirror> qualifiers,
                                 TypeMirror resultType)

returns a no arg factory method

Parameters:

mappingMethod - target mapping method

target - return type to match

qualifiers - used for further select the appropriate mapping method based on class and name

resultType - used for further select the appropriate mapping method based on resultType (bean mapping) targetType (Iterable- and MapMapping) *

Returns:

a method reference to the factory method, or null if no suitable, or ambiguous method found

getUsedVirtualMappings

Set<VirtualMappingMethod> getUsedVirtualMappings()