org.mapstruct.ap.model

Class PropertyMapping

java.lang.Object

org.mapstruct.ap.writer.FreeMarkerWritable

org.mapstruct.ap.model.common.ModelElement

org.mapstruct.ap.model.PropertyMapping

All Implemented Interfaces:

Writable

public class PropertyMapping
extends ModelElement

Represents the mapping between a source and target property, e.g. from String Source#foo to int Target#bar. Name and type of source and target property can differ. If they have different types, the mapping must either refer to a mapping method or a conversion.

Author:

Gunnar Morling

Nested Class Summary

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

Writable.Context

Constructor Summary

Constructors

Constructor and Description
PropertyMapping(String sourceBeanName, String sourceName, String sourceAccessorName, Type sourceType, String targetName, String targetAccessorName, Type targetType, MethodReference mappingMethod, TypeConversion conversion)

Method Summary

Methods

Modifier and Type	Method and Description
TypeConversion	getConversion()
Set<Type>	getImportTypes() Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.
MethodReference	getMappingMethod()
String	getSourceAccessorName()
String	getSourceBeanName()
String	getSourceName()
Type	getSourceType()
String	getTargetAccessorName()
String	getTargetName()
String	getTargetReadAccessorName()
Type	getTargetType()
boolean	isTargetAccessorSetter() Whether the target accessor is a setter method or not.
String	toString()

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, wait, wait, wait

Constructor Detail

PropertyMapping

public PropertyMapping(String sourceBeanName,
               String sourceName,
               String sourceAccessorName,
               Type sourceType,
               String targetName,
               String targetAccessorName,
               Type targetType,
               MethodReference mappingMethod,
               TypeConversion conversion)

Method Detail

getSourceBeanName

public String getSourceBeanName()

getSourceName

public String getSourceName()

getSourceAccessorName

public String getSourceAccessorName()

getSourceType

public Type getSourceType()

getTargetName

public String getTargetName()

getTargetAccessorName

public String getTargetAccessorName()

getTargetType

public Type getTargetType()

getMappingMethod

public MethodReference getMappingMethod()

getConversion

public TypeConversion getConversion()

isTargetAccessorSetter

public boolean isTargetAccessorSetter()

Whether the target accessor is a setter method or not. The only case where it is not a setter but a getter is a collection-typed property without a getter, to which elements are set by adding the source elements to the collection retrieved via the getter.

Returns:

true if the target accessor is a setter, false otherwise

getTargetReadAccessorName

public String getTargetReadAccessorName()

Returns:

the read-accessor for the target property (i.e. the getter method)

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 class ModelElement

Returns:

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

toString

public String toString()

Overrides:

toString in class Object