mapstruct#3905: Using custom class Override should compile

Author: filiphr

processor/src/main/java/org/mapstruct/ap/internal/model/AbstractMappingMethodBuilder.java

@@ -130,7 +130,14 @@ public List<Annotation> getMethodAnnotations() {
                         ctx.getElementUtils(),
                         ctx.getTypeFactory(),
                         ctx.getMessager() );
-        return new ArrayList<>( additionalAnnotationsBuilder.getProcessedAnnotations( method.getExecutable() ) );
+        List<Annotation> annotations = new ArrayList<>(
+            additionalAnnotationsBuilder.getProcessedAnnotations( method.getExecutable() )
+        );
+
+        if ( method.overridesMethod() ) {
+            annotations.add( new Annotation( ctx.getTypeFactory().getType( Override.class ) ) );
+        }
+        return annotations;
     }
 
 }

processor/src/main/java/org/mapstruct/ap/internal/model/NormalTypeMappingMethod.java

@@ -21,7 +21,6 @@
  */
 public abstract class NormalTypeMappingMethod extends MappingMethod {
     private final MethodReference factoryMethod;
-    private final boolean overridden;
     private final boolean mapNullToDefault;
 
     private final List<Annotation> annotations;
@@ -33,7 +32,6 @@ public abstract class NormalTypeMappingMethod extends MappingMethod {
         List<LifecycleCallbackMethodReference> afterMappingReferences) {
         super( method, existingVariableNames, beforeMappingReferences, afterMappingReferences );
         this.factoryMethod = factoryMethod;
-        this.overridden = method.overridesMethod();
         this.mapNullToDefault = mapNullToDefault;
         this.annotations = annotations;
     }
@@ -59,10 +57,6 @@ public boolean isMapNullToDefault() {
         return mapNullToDefault;
     }
 
-    public boolean isOverridden() {
-        return overridden;
-    }
-
     public MethodReference getFactoryMethod() {
         return this.factoryMethod;
     }

processor/src/main/resources/org/mapstruct/ap/internal/model/BeanMappingMethod.ftl

@@ -9,7 +9,6 @@
 <#list annotations as annotation>
     <#nt><@includeModel object=annotation/>
 </#list>
-<#if overridden>@Override</#if>
 <#lt>${accessibility.keyword} <@includeModel object=returnType/> ${name}(<#list parameters as param><@includeModel object=param/><#if param_has_next>, </#if></#list>)<@throws/> {
     <#assign targetType = resultType />
     <#if !existingInstanceMapping>

processor/src/main/resources/org/mapstruct/ap/internal/model/IterableMappingMethod.ftl

@@ -9,7 +9,6 @@
 <#list annotations as annotation>
     <#nt><@includeModel object=annotation/>
 </#list>
-<#if overridden>@Override</#if>
 <#lt>${accessibility.keyword} <@includeModel object=returnType/> ${name}(<#list parameters as param><@includeModel object=param/><#if param_has_next>, </#if></#list>)<@throws/> {
     <#list beforeMappingReferencesWithoutMappingTarget as callback>
     	<@includeModel object=callback targetBeanName=resultName targetType=resultType/>

processor/src/main/resources/org/mapstruct/ap/internal/model/MapMappingMethod.ftl

@@ -9,7 +9,6 @@
 <#list annotations as annotation>
     <#nt><@includeModel object=annotation/>
 </#list>
-<#if overridden>@Override</#if>
 <#lt>${accessibility.keyword} <@includeModel object=returnType /> ${name}(<#list parameters as param><@includeModel object=param/><#if param_has_next>, </#if></#list>)<@throws/> {
     <#list beforeMappingReferencesWithoutMappingTarget as callback>
     	<@includeModel object=callback targetBeanName=resultName targetType=resultType/>

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

@@ -9,7 +9,6 @@
 <#list annotations as annotation>
     <#nt><@includeModel object=annotation/>
 </#list>
-<#if overridden>@Override</#if>
 <#lt>${accessibility.keyword} <@includeModel object=returnType/> ${name}(<#list parameters as param><@includeModel object=param/><#if param_has_next>, </#if></#list>)<@throws/> {
     <#--TODO does it even make sense to do a callback if the result is a Stream, as they are immutable-->
     <#list beforeMappingReferencesWithoutMappingTarget as callback>

processor/src/test/java/org/mapstruct/ap/test/bugs/_3905/Issue3905Mapper.java

@@ -0,0 +1,17 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
+ */
+package org.mapstruct.ap.test.bugs._3905;
+
+import org.mapstruct.Mapper;
+
+/**
+ * @author Filip Hrisafov
+ */
+@Mapper
+public interface Issue3905Mapper {
+
+    OverrideDto map(Override override);
+}

processor/src/test/java/org/mapstruct/ap/test/bugs/_3905/Issue3905Test.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
+ */
+package org.mapstruct.ap.test.bugs._3905;
+
+import org.mapstruct.ap.testutil.IssueKey;
+import org.mapstruct.ap.testutil.ProcessorTest;
+import org.mapstruct.ap.testutil.WithClasses;
+
+/**
+ * @author Filip Hrisafov
+ */
+@IssueKey("3905")
+@WithClasses({
+    Issue3905Mapper.class,
+    Override.class,
+    OverrideDto.class
+})
+class Issue3905Test {
+
+    @ProcessorTest
+    void shouldCompile() {
+    }
+}

processor/src/test/java/org/mapstruct/ap/test/bugs/_3905/Override.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
+ */
+package org.mapstruct.ap.test.bugs._3905;
+
+/**
+ * @author Filip Hrisafov
+ */
+public class Override {
+
+    private final String name;
+
+    public Override(String name) {
+        this.name = name;
+    }
+
+    public String getName() {
+        return name;
+    }
+}

processor/src/test/java/org/mapstruct/ap/test/bugs/_3905/OverrideDto.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
+ */
+package org.mapstruct.ap.test.bugs._3905;
+
+/**
+ * @author Filip Hrisafov
+ */
+public class OverrideDto {
+
+    private final String name;
+
+    public OverrideDto(String name) {
+        this.name = name;
+    }
+
+    public String getName() {
+        return name;
+    }
+}