Skip to content

#3634 fix typo in experimental note #3636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
filiphr merged 1 commit into from
Jul 20, 2024
Merged

#3634 fix typo in experimental note #3636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion processor/src/main/java/org/mapstruct/ap/spi/EnumMappingStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
*
* @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 {

/**
Expand Down
2 changes: 1 addition & 1 deletion processor/src/main/java/org/mapstruct/ap/spi/EnumTransformationStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* @author Filip Hrisafov
* @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 {

/**
Expand Down
9 changes: 4 additions & 5 deletions processor/src/main/java/org/mapstruct/ap/spi/MappingExclusionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@
/**
* A service provider interface that is used to control if MapStruct is allowed to generate automatic sub-mapping for
* a given {@link TypeElement}.
*
* <p>
* When generating the implementation of a mapping method, MapStruct will apply the following routine for each
* attribute pair in the source and target object:
*
* <p>
* <ul>
* <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
Expand All @@ -30,14 +30,14 @@
* <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>
* </ul>
*
* <p>
* 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.
*
* @author Filip Hrisafov
* @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 {

/**
Expand All @@ -46,7 +46,6 @@ public interface MappingExclusionProvider {
* The given {@code typeElement} will be excluded from the automatic sub-mapping generation
*
* @param typeElement that needs to be checked
*
* @return {@code true} if MapStruct should exclude the provided {@link TypeElement} from an automatic sub-mapping
*/
boolean isExcluded(TypeElement typeElement);
Expand Down