PropertyMapping (MapStruct 1.5.5.Final)

java.lang.Object
- org.mapstruct.ap.internal.writer.FreeMarkerWritable
- - org.mapstruct.ap.internal.model.common.ModelElement
  - - org.mapstruct.ap.internal.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
Modifier and Type	Class	Description
`static class`	`PropertyMapping.ConstantMappingBuilder`
`static class`	`PropertyMapping.JavaExpressionMappingBuilder`
`static class`	`PropertyMapping.PropertyMappingBuilder`

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`Assignment`	`getAssignment()`
`Assignment`	`getDefaultValueAssignment()`
`Set<String>`	`getDependsOn()`
`Set<Type>`	`getImportTypes()`	Returns a set containing those `Type`s referenced by this model element for which an import statement needs to be declared.
`String`	`getName()`
`String`	`getSourceBeanName()`
`String`	`getTargetReadAccessorName()`
`Type`	`getTargetType()`
`String`	`getTargetWriteAccessorName()`
`int`	`hashCode()`
`boolean`	`isConstructorMapping()`
`String`	`toString()`

Methods inherited from class org.mapstruct.ap.internal.writer.FreeMarkerWritable
getTemplateName, getTemplateNameForClass, write

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getName
```
public String getName()
```
    Returns:
    
    the name of this mapping (property name on the target side)
  - getSourceBeanName
```
public String getSourceBeanName()
```
  - getTargetWriteAccessorName
```
public String getTargetWriteAccessorName()
```
  - getTargetReadAccessorName
```
public String getTargetReadAccessorName()
```
  - getTargetType
```
public Type getTargetType()
```
  - getAssignment
```
public Assignment getAssignment()
```
  - getDefaultValueAssignment
```
public Assignment getDefaultValueAssignment()
```
  - isConstructorMapping
```
public boolean isConstructorMapping()
```
  - 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.
  - getDependsOn
```
public Set<String> getDependsOn()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object