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

Javadoc and documentation polishing (#3026)

Browse Source
This commit is contained in:
Johnny Lim 2022-09-27 02:02:01 +09:00 committed by GitHub
parent 8d670e7db7
commit 811cd569bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/src/main/java/org/mapstruct/EnumMapping.java
View File

@ -98,7 +98,7 @@ public @interface EnumMapping {
* <ul>
* <li>{@link MappingConstants#SUFFIX_TRANSFORMATION} - applies the given {@link #configuration()} as a
* suffix to the source enum</li>
* <li>{@link MappingConstants#STRIP_SUFFIX_TRANSFORMATION} - strips the the given {@link #configuration()}
* <li>{@link MappingConstants#STRIP_SUFFIX_TRANSFORMATION} - strips the given {@link #configuration()}
* from the end of the source enum</li>
* <li>{@link MappingConstants#PREFIX_TRANSFORMATION} - applies the given {@link #configuration()} as a
* prefix to the source enum</li>

2
core/src/main/java/org/mapstruct/NullValueCheckStrategy.java
View File

@ -8,7 +8,7 @@ package org.mapstruct;
/**
* Strategy for dealing with null source values.
*
* <b>Note:</b> This strategy is not in effect when the a specific source presence check method is defined
* <b>Note:</b> This strategy is not in effect when a specific source presence check method is defined
* in the service provider interface (SPI).
* <p>
* <b>Note</b>: some types of mappings (collections, maps), in which MapStruct is instructed to use a getter or adder

2
processor/src/main/java/org/mapstruct/ap/internal/model/HelperMethod.java
View File

@ -176,7 +176,7 @@ public abstract class HelperMethod implements Method {
*
* @param parameter source
* @param returnType target
* @return {@code true}, iff the the type variables match
* @return {@code true}, iff the type variables match
*/
public boolean doTypeVarsMatch(Type parameter, Type returnType) {
return true;

2
processor/src/main/java/org/mapstruct/ap/internal/model/source/builtin/BuiltInMethod.java
View File

@ -190,7 +190,7 @@ public abstract class BuiltInMethod implements Method {
*
* @param parameter source
* @param returnType target
* @return {@code true}, iff the the type variables match
* @return {@code true}, iff the type variables match
*/
public boolean doTypeVarsMatch(Type parameter, Type returnType) {
return true;

2
processor/src/main/java/org/mapstruct/ap/internal/util/Message.java
View File

@ -159,7 +159,7 @@ public enum Message {
RETRIEVAL_NO_INPUT_ARGS( "Can't generate mapping method with no input arguments." ),
RETRIEVAL_DUPLICATE_MAPPING_TARGETS( "Can't generate mapping method with more than one @MappingTarget parameter." ),
RETRIEVAL_VOID_MAPPING_METHOD( "Can't generate mapping method with return type void." ),
RETRIEVAL_NON_ASSIGNABLE_RESULTTYPE( "The result type is not assignable to the the return type." ),
RETRIEVAL_NON_ASSIGNABLE_RESULTTYPE( "The result type is not assignable to the return type." ),
RETRIEVAL_ITERABLE_TO_NON_ITERABLE( "Can't generate mapping method from iterable type from java stdlib to non-iterable type." ),
RETRIEVAL_MAPPING_HAS_TARGET_TYPE_PARAMETER( "Can't generate mapping method that has a parameter annotated with @TargetType." ),
RETRIEVAL_NON_ITERABLE_TO_ITERABLE( "Can't generate mapping method from non-iterable type to iterable type from java stdlib." ),

2
processor/src/main/resources/org/mapstruct/ap/internal/model/StreamMappingMethod.ftl
View File

@ -114,7 +114,7 @@
<#else>
<#-- Streams are immutable so we can't update them -->
<#if !existingInstanceMapping>
<#--TODO fhr: after the the result is no longer the same instance, how does it affect the
<#--TODO fhr: after the result is no longer the same instance, how does it affect the
Before mapping methods. Does it even make sense to have before mapping on a stream? -->
<#if sourceParameter.type.arrayType>
<@returnLocalVarDefOrUpdate>Stream.of( ${sourceParameter.name} )<@streamMapSupplier />;</@returnLocalVarDefOrUpdate>

4
processor/src/test/java/org/mapstruct/ap/test/bugs/_1719/Issue1719Test.java
View File

@ -23,8 +23,8 @@ public class Issue1719Test {
/**
* For adder methods MapStuct cannot generate an update method. MapStruct would cannot know how to remove objects
* from the child-parent relation. It cannot even assume that the the collection can be cleared at forehand.
* Therefore the only sensible choice is for MapStruct to create a create method for the target elements.
* from the child-parent relation. It cannot even assume that the collection can be cleared at forehand.
* Therefore, the only sensible choice is for MapStruct to create a create method for the target elements.
*/
@ProcessorTest
@WithClasses(Issue1719Mapper.class)

2
processor/src/test/java/org/mapstruct/ap/test/context/ContextParameterErroneousTest.java
View File

@ -19,7 +19,7 @@ import org.mapstruct.ap.testutil.compilation.annotation.ExpectedCompilationOutco
/**
* Tests the erroneous usage of the {@link Context} annotation in the following situations:
* <ul>
* <li>using the the same context parameter type twice in the same method
* <li>using the same context parameter type twice in the same method
* </ul>
*
* @author Andreas Gudian

12
readme.md
View File

@ -114,7 +114,7 @@ plugins {
dependencies {
...
compile 'org.mapstruct:mapstruct:1.5.2.Final'
implementation 'org.mapstruct:mapstruct:1.5.2.Final'
annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.2.Final'
testAnnotationProcessor 'org.mapstruct:mapstruct-processor:1.5.2.Final' // if you are using mapstruct in test code
@ -122,7 +122,7 @@ dependencies {
...
```
If you don't work with a dependency management tool, you can obtain a distribution bundle from [SourceForge](https://sourceforge.net/projects/mapstruct/files/).
If you don't work with a dependency management tool, you can obtain a distribution bundle from [Releases page](https://github.com/mapstruct/mapstruct/releases).
## Documentation and getting help
@ -132,16 +132,16 @@ To learn more about MapStruct, refer to the [project homepage](http://mapstruct.
MapStruct uses Maven for its build. Java 11 is required for building MapStruct from source. To build the complete project, run
mvn clean install
./mvnw clean install
from the root of the project directory. To skip the distribution module, run
mvn clean install -DskipDistribution=true
./mvnw clean install -DskipDistribution=true
## Importing into IDE
MapStruct uses the gem annotation processor to generate mapping gems for it's own annotations.
Therefore for seamless integration within an IDE annotation processing needs to be enabled.
MapStruct uses the gem annotation processor to generate mapping gems for its own annotations.
Therefore, for seamless integration within an IDE annotation processing needs to be enabled.
### IntelliJ