Skip to content

#3930 Document mapstruct-processor dependency for Eclipse IDE #4120

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
gleecode04 wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −0
Open

#3930 Document mapstruct-processor dependency for Eclipse IDE #4120

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
20 changes: 20 additions & 0 deletions documentation/src/main/asciidoc/chapter-2-set-up.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,26 @@ If you are working with the Eclipse IDE, make sure to have a current version of
When importing a Maven project configured as shown above, it will set up the MapStruct annotation processor so it runs right in the IDE, whenever you save a mapper type.
Neat, isn't it?

However, depending on your Eclipse version, you may also need to add `mapstruct-processor` as a direct dependency in addition to the `annotationProcessorPaths` configuration:

[source, xml]
----
<dependencies>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>${org.mapstruct.version}</version>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>${org.mapstruct.version}</version>
</dependency>
</dependencies>
----

This is particularly important for Eclipse 2024 and later versions where the M2E's annotation processor detection may not automatically pick up processors from `annotationProcessorPaths` alone.

To double check that everything is working as expected, go to your project's properties and select "Java Compiler" -> "Annotation Processing" -> "Factory Path".
The MapStruct processor JAR should be listed and enabled there.
Any processor options configured via the compiler plug-in (see below) should be listed under "Java Compiler" -> "Annotation Processing".
Expand Down