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

#3634 fix typo in experimental note

Browse Source
This commit is contained in:
thunderhook 2024-07-07 13:49:52 +02:00 committed by Filip Hrisafov
parent eef3bdfca4
commit 52877d36c2
3 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
processor/src/main/java/org/mapstruct/ap/spi/EnumMappingStrategy.java
View File

@ -17,7 +17,7 @@ import org.mapstruct.util.Experimental;
* *
* @since 1.4 * @since 1.4
*/ */
@Experimental("This SPI can have it's signature changed in subsequent releases") @Experimental("This SPI can have its signature changed in subsequent releases")
public interface EnumMappingStrategy { public interface EnumMappingStrategy {
/** /**

2
processor/src/main/java/org/mapstruct/ap/spi/EnumTransformationStrategy.java
View File

@ -13,7 +13,7 @@ import org.mapstruct.util.Experimental;
* @author Filip Hrisafov * @author Filip Hrisafov
* @since 1.4 * @since 1.4
*/ */
@Experimental("This SPI can have it's signature changed in subsequent releases") @Experimental("This SPI can have its signature changed in subsequent releases")
public interface EnumTransformationStrategy { public interface EnumTransformationStrategy {
/** /**

9
processor/src/main/java/org/mapstruct/ap/spi/MappingExclusionProvider.java
View File

@ -12,10 +12,10 @@ import org.mapstruct.util.Experimental;
/** /**
* A service provider interface that is used to control if MapStruct is allowed to generate automatic sub-mapping for * A service provider interface that is used to control if MapStruct is allowed to generate automatic sub-mapping for
* a given {@link TypeElement}. * a given {@link TypeElement}.
* * <p>
* When generating the implementation of a mapping method, MapStruct will apply the following routine for each * When generating the implementation of a mapping method, MapStruct will apply the following routine for each
* attribute pair in the source and target object: * attribute pair in the source and target object:
* * <p>
* <ul> * <ul>
* <li>If source and target attribute have the same type, the value will be simply copied from source to target. * <li>If source and target attribute have the same type, the value will be simply copied from source to target.
* If the attribute is a collection (e.g. a `List`) a copy of the collection will be set into the target * If the attribute is a collection (e.g. a `List`) a copy of the collection will be set into the target
@ -30,14 +30,14 @@ import org.mapstruct.util.Experimental;
* <li>If MapStruct could not create a name based mapping method an error will be raised at build time, * <li>If MapStruct could not create a name based mapping method an error will be raised at build time,
* indicating the non-mappable attribute and its path.</li> * indicating the non-mappable attribute and its path.</li>
* </ul> * </ul>
* * <p>
* With this SPI the last step before raising an error can be controlled. i.e. A user can control whether MapStruct * With this SPI the last step before raising an error can be controlled. i.e. A user can control whether MapStruct
* is allowed to generate such automatic sub-mapping method (for the source or target type) or not. * is allowed to generate such automatic sub-mapping method (for the source or target type) or not.
* *
* @author Filip Hrisafov * @author Filip Hrisafov
* @since 1.2 * @since 1.2
*/ */
@Experimental("This SPI can have it's signature changed in subsequent releases") @Experimental("This SPI can have its signature changed in subsequent releases")
public interface MappingExclusionProvider { public interface MappingExclusionProvider {
/** /**
@ -46,7 +46,6 @@ public interface MappingExclusionProvider {
* The given {@code typeElement} will be excluded from the automatic sub-mapping generation * The given {@code typeElement} will be excluded from the automatic sub-mapping generation
* *
* @param typeElement that needs to be checked * @param typeElement that needs to be checked
*
* @return {@code true} if MapStruct should exclude the provided {@link TypeElement} from an automatic sub-mapping * @return {@code true} if MapStruct should exclude the provided {@link TypeElement} from an automatic sub-mapping
*/ */
boolean isExcluded(TypeElement typeElement); boolean isExcluded(TypeElement typeElement);