chore!: switch from name based regex matching to @AutoMethod based id matching

Author: JonasDevDE

annotationprocessor/src/main/java/com/interguess/autoimpl/annotationprocessor/generator/ImplementationClassGenerator.java

@@ -28,6 +28,7 @@
 import com.interguess.autoimpl.annotationprocessor.collectors.MethodCollector;
 import com.interguess.autoimpl.annotationprocessor.utils.ResourceFileLoaderUtil;
 import com.interguess.autoimpl.api.annotations.AutoImpl;
+import com.interguess.autoimpl.api.annotations.AutoMethod;
 import com.interguess.autoimpl.api.method.MethodType;
 import com.interguess.autoimpl.api.method.MethodTypeMatcher;
 import com.interguess.autoimpl.common.method.MethodTypeMatcherImpl;
@@ -89,7 +90,9 @@ public void generateForInterface(final @NotNull TypeElement interfaceElement) {
         final MethodCollector methodCollector = new MethodCollector();
 
         for (final Element enclosed : interfaceElement.getEnclosedElements()) {
-            if (enclosed.getKind() == ElementKind.METHOD) {
+            final AutoMethod autoMethodAnnotation = enclosed.getAnnotation(AutoMethod.class);
+
+            if (enclosed.getKind() == ElementKind.METHOD && autoMethodAnnotation != null) {
                 final ExecutableElement method = (ExecutableElement) enclosed;
 
                 final MethodType methodType = this.methodTypeMatcher.match(method);

annotationprocessor/src/main/java/com/interguess/autoimpl/annotationprocessor/processors/AutoImplProcessor.java

@@ -106,6 +106,13 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
         for (final Element element : roundEnv.getElementsAnnotatedWith(AutoImpl.class)) {
             if (element.getKind() == ElementKind.INTERFACE) {
                 this.classGenerator.generateForInterface((TypeElement) element);
+            } else {
+                this.processingEnv.getMessager().printMessage(
+                        Diagnostic.Kind.ERROR,
+                        "@AutoImpl can only be applied to interfaces. " +
+                                "Invalid element: " + element.getSimpleName(),
+                        element
+                );
             }
         }
 

api/src/main/java/com/interguess/autoimpl/api/annotations/AutoMethod.java

@@ -0,0 +1,37 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2025 Interguess.com
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.interguess.autoimpl.api.annotations;
+
+import org.jetbrains.annotations.NotNull;
+
+public @interface AutoMethod {
+
+    /**
+     * The id of the method's code-generator which should be used to generate the implementation of the annotated method.
+     *
+     * @return the id of the method's code-generator to use.
+     */
+    @NotNull String value();
+}

api/src/main/java/com/interguess/autoimpl/api/annotations/RegisterMethod.java

@@ -41,9 +41,11 @@
 public @interface RegisterMethod {
 
     /**
-     * The regex pattern to match the method name.
+     * The id of the method type.
+     * Every method type must have a unique id which then can be used in the @AutoMethod annotation to set
+     * the code generator for this specific method.
      *
-     * @return The regex pattern as a string.
+     * @return the id of the method type.
      */
     @NotNull String value();
 }

api/src/main/java/com/interguess/autoimpl/api/method/MethodTypeMatcher.java

@@ -60,22 +60,22 @@ public static boolean isInitialized() {
     public abstract @NotNull List<MethodType> getRegisteredTypes();
 
     /**
-     * Registers a method type with a regex pattern for matching method names.
+     * Registers a method type with a specific id.
      *
-     * @param methodNameRegex the regex pattern to match method names
-     * @param type            the MethodType to register
+     * @param methodTypeId the id of the MethodType to register, as specified in the AutoMethod annotation
+     * @param type         the MethodType to register
      */
-    public abstract void registerType(@NotNull String methodNameRegex, @NotNull MethodType type);
+    public abstract void registerType(@NotNull String methodTypeId, @NotNull MethodType type);
 
     /**
-     * Unregisters a method type.
+     * Unregisters a method type by its id.
      *
-     * @param type the MethodType to unregister
+     * @param methodTypeId the id of the MethodType to unregister
      */
-    public abstract void unregisterType(@NotNull MethodType type);
+    public abstract void unregisterType(@NotNull String methodTypeId);
 
     /**
-     * Matches a method type based on the method name of the provided ExecutableElement.
+     * Matches a method type based on the @AutoMethod annotation of the given ExecutableElement.
      *
      * @param method the ExecutableElement representing the method to match
      * @return the matched MethodType, or null if no match is found

common/src/main/java/com/interguess/autoimpl/common/method/MethodTypeMatcherImpl.java

@@ -24,6 +24,7 @@
 
 package com.interguess.autoimpl.common.method;
 
+import com.interguess.autoimpl.api.annotations.AutoMethod;
 import com.interguess.autoimpl.api.exception.MethodTypeRegistrationException;
 import com.interguess.autoimpl.api.method.MethodType;
 import com.interguess.autoimpl.api.method.MethodTypeMatcher;
@@ -52,30 +53,33 @@ public MethodTypeMatcherImpl() {
     }
 
     @Override
-    public void registerType(@NotNull String methodNameRegex, @NotNull MethodType type) {
-        if (this.types.containsKey(methodNameRegex)) {
-            throw new MethodTypeRegistrationException("Method type with name regex '" + methodNameRegex + "' is already registered.");
+    public void registerType(@NotNull String methodTypeId, @NotNull MethodType type) {
+        if (this.types.containsKey(methodTypeId)) {
+            throw new MethodTypeRegistrationException("Method type with the id '" + methodTypeId + "' is already registered.");
         }
 
-        this.types.put(methodNameRegex, type);
+        this.types.put(methodTypeId, type);
     }
 
     @Override
-    public void unregisterType(@NotNull MethodType type) {
-        this.types.values().removeIf(existingType -> existingType.equals(type));
+    public void unregisterType(@NotNull String methodTypeId) {
+        this.types.remove(methodTypeId);
     }
 
     @Override
     public @Nullable MethodType match(@NotNull ExecutableElement method) {
-        for (final Map.Entry<String, MethodType> entry : this.types.entrySet()) {
-            final String methodNameRegex = entry.getKey();
-            final MethodType methodType = entry.getValue();
+        final AutoMethod annotation = method.getAnnotation(AutoMethod.class);
 
-            if (method.getSimpleName().toString().matches(methodNameRegex)) {
-                return methodType;
-            }
+        if (annotation == null) {
+            throw new IllegalStateException("Method " + method.getSimpleName() + " is not annotated with @AutoMethod");
         }
 
-        return null;
+        final MethodType type = this.types.get(annotation.value());
+
+        if (type == null) {
+            throw new IllegalStateException("No method type registered with the id '" + annotation.value() + "'");
+        }
+
+        return type;
     }
 }

common/src/main/java/com/interguess/autoimpl/common/methodtypes/GetMethod.java

@@ -35,7 +35,7 @@
 import javax.lang.model.element.ExecutableElement;
 import java.util.List;
 
-@RegisterMethod("get[a-zA-Z0-9_]+")
+@RegisterMethod("get")
 public class GetMethod implements MethodType {
 
     @Override

common/src/main/java/com/interguess/autoimpl/common/methodtypes/SetMethod.java

@@ -35,7 +35,7 @@
 import javax.lang.model.element.ExecutableElement;
 import java.util.List;
 
-@RegisterMethod("set[a-zA-Z0-9_]+")
+@RegisterMethod("set")
 public class SetMethod implements MethodType {
 
     @Override