org.mapstruct.ap.model.assignment

Class GetterWrapperForCollectionsAndMaps

java.lang.Object

org.mapstruct.ap.writer.FreeMarkerWritable

org.mapstruct.ap.model.common.ModelElement

org.mapstruct.ap.model.assignment.AssignmentWrapper

org.mapstruct.ap.model.assignment.GetterWrapperForCollectionsAndMaps

All Implemented Interfaces:

Assignment, Writable

public class GetterWrapperForCollectionsAndMaps
extends AssignmentWrapper

This wrapper handles the situation were an assignment must be done via a target getter method because there is no setter available. The wrapper checks if there is an collection or map initialized on the target bean (not null). If so it uses the addAll (for collections) or putAll (for maps). The collection / map is cleared in case of a pre-existing target MappingTargetbefore adding the source entries. The goal is that the same collection / map is used as target. Nothing can be added if the getter on the target returns null.

Author:

Sjaak Derksen

Nested Class Summary

Nested classes/interfaces inherited from interface org.mapstruct.ap.model.assignment.Assignment

Assignment.AssignmentType

Nested classes/interfaces inherited from interface org.mapstruct.ap.writer.Writable

Writable.Context

Constructor Summary

Constructors

Constructor and Description
GetterWrapperForCollectionsAndMaps(Assignment decoratedAssignment, List<Type> exceptionTypesToExclude, Type targetType, Collection<String> existingVariableNames)

Method Summary

Modifier and Type	Method and Description
List<Type>	getExceptionTypes() returns all types exception types thrown by this assignment.
Set<Type>	getImportTypes() Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.
String	getLocalVarName()

Methods inherited from class org.mapstruct.ap.model.assignment.AssignmentWrapper

getAssignment, getSourceReference, getType, isUpdateMethod, setAssignment

Methods inherited from class org.mapstruct.ap.model.common.ModelElement

write

Methods inherited from class org.mapstruct.ap.writer.FreeMarkerWritable

getTemplateName

Methods inherited from class java.lang.Object

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

Constructor Detail

GetterWrapperForCollectionsAndMaps

public GetterWrapperForCollectionsAndMaps(Assignment decoratedAssignment,
                                          List<Type> exceptionTypesToExclude,
                                          Type targetType,
                                          Collection<String> existingVariableNames)

Method Detail

getExceptionTypes

public List<Type> getExceptionTypes()

Description copied from interface: Assignment

returns all types exception types thrown by this assignment.

Specified by:

getExceptionTypes in interface Assignment

Overrides:

getExceptionTypes in class AssignmentWrapper

Returns:

exceptions thrown

getImportTypes

public Set<Type> getImportTypes()

Description copied from class: ModelElement

Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.

Specified by:

getImportTypes in interface Assignment

Overrides:

getImportTypes in class AssignmentWrapper

Returns:

A set with type referenced by this model element. Must not be null.

getLocalVarName

public String getLocalVarName()