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

Updating readme.md prior to 1.0.0.Final release

Browse Source
This commit is contained in:
Gunnar Morling 2015-11-25 22:26:45 +01:00
parent 7c2b4c9541
commit a45611315a
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
readme.md
View File

@ -1,6 +1,6 @@
# MapStruct - Java bean mappings, the easy way! # MapStruct - Java bean mappings, the easy way!
_Version: 1.0.0.CR2, August 27th 2015_ _Version: 1.0.0.Final, November 25th 2015_
## What is MapStruct? ## What is MapStruct?
@ -16,6 +16,9 @@ Compared to dynamic mapping frameworks, MapStruct offers the following advantage
* Compile-time type safety: Only objects and attributes mapping to each other can be mapped, no accidental mapping of an order entity into a customer DTO etc. * Compile-time type safety: Only objects and attributes mapping to each other can be mapped, no accidental mapping of an order entity into a customer DTO etc.
* Self-contained code, no runtime dependencies * Self-contained code, no runtime dependencies
* Clear error-reports at build time, if entities or attributes can't be mapped * Clear error-reports at build time, if entities or attributes can't be mapped
* Mapping code is easy to debug (or edited by hand e.g. in case of a bug in the generator)
MapStruct works in command line builds (plain javac, via Maven, Gradle, Ant etc.) and IDEs. For Eclipse, there is a dedicated plug-in under development (see https://github.com/mapstruct/mapstruct-eclipse) which goes beyond what's possible with an annotation processor, providing content assist for annotation attributes, quick fixes and more.
## Documentation and getting help ## Documentation and getting help
@ -35,7 +38,7 @@ For Maven based projects add the following to your POM file in order to use MapS
... ...
<properties> <properties>
<org.mapstruct.version>[current MapStruct version]</org.mapstruct.version> <org.mapstruct.version>1.0.0.Final</org.mapstruct.version>
</properties> </properties>
... ...
<dependencies> <dependencies>
@ -44,6 +47,12 @@ For Maven based projects add the following to your POM file in order to use MapS
<artifactId>mapstruct</artifactId> <artifactId>mapstruct</artifactId>
<version>${org.mapstruct.version}</version> <version>${org.mapstruct.version}</version>
</dependency> </dependency>
<!-- Use this with Java 8 and beyond -->
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-jdk8</artifactId>
<version>${org.mapstruct.version}</version>
</dependency>
</dependencies> </dependencies>
... ...
<build> <build>