org.mapstruct.ap.internal.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, SelectionParameters selectionParameters) returns a no arg factory method
Assignment	getTargetAssignment(Method mappingMethod, Type targetType, String targetPropertyName, FormattingParameters formattingParameters, SelectionParameters selectionParameters, SourceRHS sourceRHS, boolean preferUpdateMethods) returns a parameter assignment
Set<VirtualMappingMethod>	getUsedVirtualMappings()

Method Detail

getTargetAssignment

Assignment getTargetAssignment(Method mappingMethod,
                               Type targetType,
                               String targetPropertyName,
                               FormattingParameters formattingParameters,
                               SelectionParameters selectionParameters,
                               SourceRHS sourceRHS,
                               boolean preferUpdateMethods)

returns a parameter assignment

Parameters:

mappingMethod - target mapping method

targetType - return type to match

targetPropertyName - name of the target property

formattingParameters - used for formatting dates and numbers

selectionParameters - parameters used in the selection process

sourceRHS - source information

preferUpdateMethods - selection should prefer update methods when present.

Returns:

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

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

getFactoryMethod

MethodReference getFactoryMethod(Method mappingMethod,
                                 Type target,
                                 SelectionParameters selectionParameters)

returns a no arg factory method

Parameters:

mappingMethod - target mapping method

target - return type to match

selectionParameters - parameters used in the selection process

Returns:

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

getUsedVirtualMappings

Set<VirtualMappingMethod> getUsedVirtualMappings()