jomu/mapstruct-support
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 4 Activity

updated documentation

Browse Source
This commit is contained in:
Joern Muehlencord
2023-08-26 13:24:38 +02:00
parent 5116a0741b
commit 980f8d90c7
3 changed files with 44 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -2,13 +2,34 @@
Additional DefaultAccessorNamingStrategy to support fluent API withXYZ setters.
[![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](https://github.com/mapstruct/mapstruct/blob/master/LICENSE.txt)
[![Build Status](https://github.com/mapstruct/mapstruct-idea/workflows/CI/badge.svg?branch=master)](https://github.com/mapstruct/mapstruct-idea/actions?query=workflow%3ACI+branch%3Amaster)
[![Coverage Status](https://codecov.io/gh/mapstruct/mapstruct-idea/branch/master/graph/badge.svg)](https://codecov.io/gh/mapstruct/mapstruct-idea)
* [What is MapStruct?](#what-is-mapstruct)
* [Features](#features)
* [Usage](#usage)
* [Example](#example)
* [Requirements](#requirements)
* [Building from Source](#building-from-source)
* [Licensing](#licensing)
## What is MapStruct?
MapStruct is a Java [annotation processor](https://docs.oracle.com/javase/6/docs/technotes/guides/apt/index.html) for the generation of type-safe and performant mappers for Java bean classes.
To learn more about MapStruct have a look at the [mapstruct](https://github.com/mapstruct/mapstruct) repository or the [website](https://mapstruct.org/)
## Features
Mapstruct default naming strategy detects the methods `withFirstName` and `withLastName` (see example below) as extra
target fields and therefore cause an error, when the mapper is annotated with
`unmappedTargetPolicy = ReportingPolicy.ERROR`.
The additional naming strategy makes Mapstruct ignore the withXYZ setters.
## Installation
## Usage
To use the extended naming strategy, just include it as project dependency alongside with mapstruct.
@ -18,12 +39,12 @@ To use the extended naming strategy, just include it as project dependency along
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>1.4.2.Final</version>
<version>1.5.5.Final</version>
</dependency>
<dependency>
<groupId>de.muehlencord.mapstruct</groupId>
<artifactId>mapstruct-support</artifactId>
<version>1.4.2</version>
<version>1.5.5</version>
</dependency>
</dependencies>
```
@ -71,3 +92,17 @@ public class Person {
```
## Requirements
The MapStruct plugin requires Java 11 or later
## Building from Source
mapstruct-support uses maven as build system. Simple execute
```shell
mvn clean install
```
## Licensing
The MapStruct plugin is licensed under the Apache License, Version 2.0 (the "License"); you may not use it except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.