Skip to content

#3858 Compilation error if no methods are found to @InheritConfiguration from #3894

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

Open
nikolaizhnikolov wants to merge 2 commits into
base: main
Choose a base branch
from
Open

#3858 Compilation error if no methods are found to @InheritConfiguration from #3894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9883aa
#3858 Compilation error if no mapper configuration was found to inher…
nikolaizhnikolov Jun 26, 2025
af4737e
Merge remote-tracking branch 'origin/main'
nikolaizhnikolov Jun 26, 2025
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 documentation/src/main/asciidoc/chapter-11-reusing-mapping-configurations.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public interface CarMapper {

The example above declares a mapping method `carDtoToCar()` with a configuration to define how the property `numberOfSeats` in the type `Car` shall be mapped. The update method that performs the mapping on an existing instance of `Car` needs the same configuration to successfully map all properties. Declaring `@InheritConfiguration` on the method lets MapStruct search for inheritance candidates to apply the annotations of the method that is inherited from.

One method *A* can inherit the configuration from another method *B* if all types of *A* (source types and result type) are assignable to the corresponding types of *B*.
One method *A* is considered *similar* and can inherit the configuration from another method *B* if all types of *A* (source types and result type) are assignable to the corresponding types of *B*. If methods are not resolved as *similar* a compilation error will be raised.

Methods that are considered for inheritance need to be defined in the current mapper, a super class/interface, or in the shared configuration interface (as described in <<shared-configurations>>).

Expand Down
7 changes: 7 additions & 0 deletions processor/src/main/java/org/mapstruct/ap/internal/processor/MapperCreationProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,6 +723,13 @@ else if ( nameFilteredCandidates.size() > 1 ) {
else {
reportErrorWhenAmbiguousMapping( candidates, method, inheritConfiguration );
}
} else {
messager.printMessage(
method.getExecutable(),
Message.INHERITCONFIGURATION_PARAMETER_MISMATCH,
method.getName(),
resultMethod.getName()
);
}
}

Expand Down
1 change: 1 addition & 0 deletions processor/src/main/java/org/mapstruct/ap/internal/util/Message.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ public enum Message {
INHERITCONFIGURATION_DUPLICATE_MATCHES( "Given name \"%s\" matches several candidate methods: %s." ),
INHERITCONFIGURATION_NO_NAME_MATCH( "Given name \"%s\" does not match the only candidate. Did you mean: \"%s\"." ),
INHERITCONFIGURATION_MULTIPLE_PROTOTYPE_METHODS_MATCH( "More than one configuration prototype method is applicable. Use @InheritConfiguration to select one of them explicitly: %s." ),
INHERITCONFIGURATION_PARAMETER_MISMATCH("Method \"%s\" cannot inherit configuration from \"%s\" because their parameters do not match."),
INHERITINVERSECONFIGURATION_MULTIPLE_PROTOTYPE_METHODS_MATCH( "More than one configuration prototype method is applicable. Use @InheritInverseConfiguration to select one of them explicitly: %s." ),
INHERITCONFIGURATION_CYCLE( "Cycle detected while evaluating inherited configurations. Inheritance path: %s" ),

Expand Down