third_codes/mapstruct
1
0
Fork 0
mirror of https://github.com/mapstruct/mapstruct.git synced 2025-07-12 00:00:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

#1995 and mapstruct/mapstruct.org#101 nesting calling custom method (#1999)

Browse Source 
Co-authored-by: coffman21 <fire2low@gmail.com>
This commit is contained in:
Sjaak Derksen 2020-01-09 20:59:36 +01:00 committed by GitHub
parent c153c8bf5a
commit 57cfd35afc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 58 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
documentation/src/main/asciidoc/chapter-5-data-type-conversions.asciidoc
View File

@ -253,6 +253,62 @@ This means that it is possible for MapStruct not to report unmapped target prope
====
[[invoking-custom-mapping-method]]
=== Invoking custom mapping method
Sometimes mappings are not straightforward and some fields require custom logic.
The example below demonstrates how the properties `length`, `width` and `height` in `FishTank` can be mapped to the `VolumeDto` bean, which is a member of `FishTankWithVolumeDto`. `VolumeDto` contains the properties `volume` and `description`. Custom logic is achieved by defining a method which takes `FishTank` instance as a parameter and returns a `VolumeDto`. MapStruct will take the entire parameter `source` and generate code to call the custom method `mapVolume` in order to map the `FishTank` object to the target property `volume`.
The remainder of the fields could be mapped the regular way: using mappings defined defined by means of `@Mapping` annotations.
.Manually implemented mapping method
====
[source, java, linenums]
[subs="verbatim,attributes"]
----
public class FishTank {
Fish fish;
String material;
Quality quality;
int length;
int width;
int height;
}
public class FishTankWithVolumeDto {
FishDto fish;
MaterialDto material;
QualityDto quality;
VolumeDto volume;
}
public class VolumeDto {
int volume;
String description;
}
@Mapper
public abstract class FishTankMapperWithVolume {
@Mapping(target = "fish.kind", source = "source.fish.type")
@Mapping(target = "material.materialType", source = "source.material")
@Mapping(target = "quality.document", source = "source.quality.report")
@Mapping(target = "volume", source = "source")
abstract FishTankWithVolumeDto map(FishTank source);
VolumeDto mapVolume(FishTank source) {
int volume = source.length * source.width * source.height;
String desc = volume < 100 ? "Small" : "Large";
return new VolumeDto(volume, desc);
}
}
----
====
Note the `@Mapping` annotation where `source` field is equal to `"source"`, indicating the parameter name `source` itself in the method `map(FishTank source)` in stead of a (target) property in `FishTank`.
[[invoking-other-mappers]]
=== Invoking other mappers
@ -293,7 +349,7 @@ In the `@Mapper` annotation at the `CarMapper` interface reference the `DateMapp
[subs="verbatim,attributes"]
----
@Mapper(uses=DateMapper.class)
public class CarMapper {
public interface CarMapper {
CarDto carToCarDto(Car car);
}
@ -620,4 +676,4 @@ public interface MovieMapper {
[WARNING]
====
Although the used mechanism is the same, the user has to be a bit more careful. Refactoring the name of a defined qualifier in an IDE will neatly refactor all other occurrences as well. This is obviously not the case for changing a name.
====
====