Merge pull request #1431 from jeffgbutler/java-merging

Refactor the Mergers and Associated Tests

Author: jeffgbutler

core/mybatis-generator-core/pom.xml

@@ -100,6 +100,11 @@
       <artifactId>kotlin-stdlib</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.reflections</groupId>
+      <artifactId>reflections</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

core/mybatis-generator-core/src/main/java/org/mybatis/generator/api/MyBatisGenerator.java

@@ -49,7 +49,7 @@
 import org.mybatis.generator.exception.ShellException;
 import org.mybatis.generator.internal.DefaultShellCallback;
 import org.mybatis.generator.internal.ObjectFactory;
-import org.mybatis.generator.internal.XmlFileMergerJaxp;
+import org.mybatis.generator.merge.xml.XmlFileMergerJaxp;
 
 /**
  * This class is the main interface to MyBatis generator. A typical execution of the tool involves these steps:

core/mybatis-generator-core/src/main/java/org/mybatis/generator/internal/JavaMergingShellCallback.java

@@ -19,6 +19,7 @@
 
 import org.jspecify.annotations.Nullable;
 import org.mybatis.generator.exception.ShellException;
+import org.mybatis.generator.merge.java.JavaFileMerger;
 
 public class JavaMergingShellCallback extends DefaultShellCallback {
 

…s/generator/internal/JavaFileMerger.java …generator/merge/java/JavaFileMerger.javacore/mybatis-generator-core/src/main/java/org/mybatis/generator/internal/JavaFileMerger.java renamed to core/mybatis-generator-core/src/main/java/org/mybatis/generator/merge/java/JavaFileMerger.java core/mybatis-generator-core/src/main/java/org/mybatis/generator/internal/JavaFileMerger.java renamed to core/mybatis-generator-core/src/main/java/org/mybatis/generator/merge/java/JavaFileMerger.java

@@ -13,7 +13,7 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-package org.mybatis.generator.internal;
+package org.mybatis.generator.merge.java;
 
 import static org.mybatis.generator.internal.util.messages.Messages.getString;
 
@@ -96,7 +96,8 @@ public static String getMergedSource(String newFileSource, String existingFileCo
             CompilationUnit existingCompilationUnit = existingParseResult.getResult().orElseThrow();
 
             // Perform the merge
-            CompilationUnit mergedCompilationUnit = performMerge(newCompilationUnit, existingCompilationUnit, javadocTags);
+            CompilationUnit mergedCompilationUnit =
+                    performMerge(newCompilationUnit, existingCompilationUnit, javadocTags);
 
             return mergedCompilationUnit.toString();
         } catch (Exception e) {
@@ -127,9 +128,9 @@ private static boolean hasGeneratedAnnotation(BodyDeclaration<?> member) {
         for (AnnotationExpr annotation : member.getAnnotations()) {
             String annotationName = annotation.getNameAsString();
             // Check for @Generated annotation (both javax and jakarta packages)
-            if ("Generated".equals(annotationName) ||
-                "javax.annotation.Generated".equals(annotationName) ||
-                "jakarta.annotation.Generated".equals(annotationName)) {
+            if ("Generated".equals(annotationName)
+                    || "javax.annotation.Generated".equals(annotationName)
+                    || "jakarta.annotation.Generated".equals(annotationName)) {
                 return true;
             }
         }
@@ -177,12 +178,14 @@ public int compareTo(ImportInfo other) {
 
         // Add imports from new file
         for (ImportDeclaration importDecl : mergedCompilationUnit.getImports()) {
-            allImports.add(new ImportInfo(importDecl.getNameAsString(), importDecl.isStatic(), importDecl.isAsterisk()));
+            allImports.add(
+                    new ImportInfo(importDecl.getNameAsString(), importDecl.isStatic(), importDecl.isAsterisk()));
         }
 
         // Add imports from existing file (avoiding duplicates)
         for (ImportDeclaration importDecl : existingCompilationUnit.getImports()) {
-            allImports.add(new ImportInfo(importDecl.getNameAsString(), importDecl.isStatic(), importDecl.isAsterisk()));
+            allImports.add(
+                    new ImportInfo(importDecl.getNameAsString(), importDecl.isStatic(), importDecl.isAsterisk()));
         }
 
         // Clear existing imports and add sorted imports
@@ -207,13 +210,14 @@ private static int getImportPriority(String importName) {
         }
     }
 
-    private static void addPreservedElements(CompilationUnit existingCompilationUnit, CompilationUnit mergedCompilationUnit, String[] javadocTags) {
+    private static void addPreservedElements(CompilationUnit existingCompilationUnit,
+                                             CompilationUnit mergedCompilationUnit, String[] javadocTags) {
         // Find the main type declarations
         TypeDeclaration<?> existingTypeDeclaration = findMainTypeDeclaration(existingCompilationUnit);
         TypeDeclaration<?> mergedTypeDeclaration = findMainTypeDeclaration(mergedCompilationUnit);
 
-        if (existingTypeDeclaration instanceof ClassOrInterfaceDeclaration existingClassDeclaration &&
-            mergedTypeDeclaration instanceof ClassOrInterfaceDeclaration mergedClassDeclaration) {
+        if (existingTypeDeclaration instanceof ClassOrInterfaceDeclaration existingClassDeclaration
+                && mergedTypeDeclaration instanceof ClassOrInterfaceDeclaration mergedClassDeclaration) {
 
             // Add only non-generated members from the existing class to the end of merged class
             for (BodyDeclaration<?> member : existingClassDeclaration.getMembers()) {
@@ -224,7 +228,7 @@ private static void addPreservedElements(CompilationUnit existingCompilationUnit
         }
     }
 
-    private static TypeDeclaration<?> findMainTypeDeclaration(CompilationUnit compilationUnit) {
+    private static @Nullable TypeDeclaration<?> findMainTypeDeclaration(CompilationUnit compilationUnit) {
         // Return the first public type declaration, or the first type declaration if no public one exists
         TypeDeclaration<?> firstType = null;
         for (TypeDeclaration<?> typeDeclaration : compilationUnit.getTypes()) {

core/mybatis-generator-core/src/main/java/org/mybatis/generator/merge/java/package-info.java

@@ -0,0 +1,19 @@
+/*
+ *    Copyright 2006-2026 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+@NullMarked
+package org.mybatis.generator.merge.java;
+
+import org.jspecify.annotations.NullMarked;

…ybatis/generator/internal/DomWriter.java …batis/generator/merge/xml/DomWriter.javacore/mybatis-generator-core/src/main/java/org/mybatis/generator/internal/DomWriter.java renamed to core/mybatis-generator-core/src/main/java/org/mybatis/generator/merge/xml/DomWriter.java core/mybatis-generator-core/src/main/java/org/mybatis/generator/internal/DomWriter.java renamed to core/mybatis-generator-core/src/main/java/org/mybatis/generator/merge/xml/DomWriter.java

@@ -13,7 +13,7 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-package org.mybatis.generator.internal;
+package org.mybatis.generator.merge.xml;
 
 import static org.mybatis.generator.internal.util.messages.Messages.getString;
 

…enerator/internal/XmlFileMergerJaxp.java …nerator/merge/xml/XmlFileMergerJaxp.javacore/mybatis-generator-core/src/main/java/org/mybatis/generator/internal/XmlFileMergerJaxp.java renamed to core/mybatis-generator-core/src/main/java/org/mybatis/generator/merge/xml/XmlFileMergerJaxp.java core/mybatis-generator-core/src/main/java/org/mybatis/generator/internal/XmlFileMergerJaxp.java renamed to core/mybatis-generator-core/src/main/java/org/mybatis/generator/merge/xml/XmlFileMergerJaxp.java

@@ -13,7 +13,7 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-package org.mybatis.generator.internal;
+package org.mybatis.generator.merge.xml;
 
 import static org.mybatis.generator.internal.util.messages.Messages.getString;
 

core/mybatis-generator-core/src/main/java/org/mybatis/generator/merge/xml/package-info.java

@@ -0,0 +1,19 @@
+/*
+ *    Copyright 2006-2026 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+@NullMarked
+package org.mybatis.generator.merge.xml;
+
+import org.jspecify.annotations.NullMarked;

core/mybatis-generator-core/src/site/xhtml/running/runningWithAnt.xhtml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-       Copyright 2006-2025 the original author or authors.
+       Copyright 2006-2026 the original author or authors.
 
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.

core/mybatis-generator-core/src/site/xhtml/running/runningWithMaven.xhtml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-       Copyright 2006-2025 the original author or authors.
+       Copyright 2006-2026 the original author or authors.
 
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.