Manage internal error numbers with an enum

Author: jeffgbutler

src/main/java/org/mybatis/dynamic/sql/select/render/FetchFirstPagingModelRenderer.java

@@ -21,6 +21,7 @@
 import org.mybatis.dynamic.sql.render.RenderingStrategy;
 import org.mybatis.dynamic.sql.select.PagingModel;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
+import org.mybatis.dynamic.sql.util.InternalError;
 import org.mybatis.dynamic.sql.util.Messages;
 
 public class FetchFirstPagingModelRenderer {
@@ -49,7 +50,8 @@ private FragmentAndParameters renderWithOffset(Long offset) {
 
     private FragmentAndParameters renderFetchFirstRowsOnly() {
         return pagingModel.fetchFirstRows().map(this::renderFetchFirstRowsOnly)
-                .orElseThrow(() -> new InvalidSqlException(Messages.getInternalErrorString(13)));
+                .orElseThrow(() ->
+                        new InvalidSqlException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_13)));
     }
 
     private FragmentAndParameters renderFetchFirstRowsOnly(Long fetchFirstRows) {

src/main/java/org/mybatis/dynamic/sql/util/GeneralInsertMappingVisitor.java

@@ -18,21 +18,21 @@
 public abstract class GeneralInsertMappingVisitor<R> implements ColumnMappingVisitor<R> {
     @Override
     public final R visit(SelectMapping mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(1));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_1));
     }
 
     @Override
     public final R visit(PropertyMapping mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(2));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_2));
     }
 
     @Override
     public final R visit(PropertyWhenPresentMapping mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(3));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_3));
     }
 
     @Override
     public final R visit(ColumnToColumnMapping columnMapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(4));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_4));
     }
 }

src/main/java/org/mybatis/dynamic/sql/util/InsertMappingVisitor.java

@@ -18,26 +18,26 @@
 public abstract class InsertMappingVisitor<R> implements ColumnMappingVisitor<R> {
     @Override
     public final <T> R visit(ValueMapping<T> mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(5));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_5));
     }
 
     @Override
     public final <T> R visit(ValueOrNullMapping<T> mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(6));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_6));
     }
 
     @Override
     public final <T> R visit(ValueWhenPresentMapping<T> mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(7));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_7));
     }
 
     @Override
     public final R visit(SelectMapping mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(8));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_8));
     }
 
     @Override
     public final R visit(ColumnToColumnMapping columnMapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(9));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_9));
     }
 }

src/main/java/org/mybatis/dynamic/sql/util/InternalError.java

@@ -0,0 +1,45 @@
+/*
+ *    Copyright 2016-2023 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.
+ */
+package org.mybatis.dynamic.sql.util;
+
+/**
+ * Enum for managing internal error numbers.
+ */
+public enum InternalError {
+    INTERNAL_ERROR_1(1),
+    INTERNAL_ERROR_2(2),
+    INTERNAL_ERROR_3(3),
+    INTERNAL_ERROR_4(4),
+    INTERNAL_ERROR_5(5),
+    INTERNAL_ERROR_6(6),
+    INTERNAL_ERROR_7(7),
+    INTERNAL_ERROR_8(8),
+    INTERNAL_ERROR_9(9),
+    INTERNAL_ERROR_10(10),
+    INTERNAL_ERROR_11(11),
+    INTERNAL_ERROR_12(12),
+    INTERNAL_ERROR_13(13);
+
+    private final int number;
+
+    InternalError(int number) {
+        this.number = number;
+    }
+
+    public int getNumber() {
+        return number;
+    }
+}

src/main/java/org/mybatis/dynamic/sql/util/Messages.java

@@ -37,7 +37,7 @@ public static String getString(String key, String p1, String p2, String p3) {
         return MessageFormat.format(getString(key), p1, p2, p3);
     }
 
-    public static String getInternalErrorString(int internalErrorNumber) {
-        return MessageFormat.format(getString("INTERNAL.ERROR"), internalErrorNumber); //$NON-NLS-1$
+    public static String getInternalErrorString(InternalError internalError) {
+        return MessageFormat.format(getString("INTERNAL.ERROR"), internalError.getNumber()); //$NON-NLS-1$
     }
 }

src/main/java/org/mybatis/dynamic/sql/util/MultiRowInsertMappingVisitor.java

@@ -18,6 +18,6 @@
 public abstract class MultiRowInsertMappingVisitor<R> extends InsertMappingVisitor<R> {
     @Override
     public final R visit(PropertyWhenPresentMapping mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(12));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_12));
     }
 }

src/main/java/org/mybatis/dynamic/sql/util/UpdateMappingVisitor.java

@@ -18,11 +18,11 @@
 public abstract class UpdateMappingVisitor<R> implements ColumnMappingVisitor<R> {
     @Override
     public final R visit(PropertyMapping mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(10));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_10));
     }
 
     @Override
     public final R visit(PropertyWhenPresentMapping mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(11));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_11));
     }
 }

src/test/java/org/mybatis/dynamic/sql/InvalidSQLTest.java

@@ -44,6 +44,7 @@
 import org.mybatis.dynamic.sql.select.join.JoinType;
 import org.mybatis.dynamic.sql.select.render.PagingModelRenderer;
 import org.mybatis.dynamic.sql.update.UpdateModel;
+import org.mybatis.dynamic.sql.util.InternalError;
 import org.mybatis.dynamic.sql.util.Messages;
 
 class InvalidSQLTest {
@@ -241,7 +242,7 @@ void testInvalidPagingModel() {
 
         assertThatExceptionOfType(InvalidSqlException.class)
                 .isThrownBy(renderer::render)
-                .withMessage(Messages.getInternalErrorString(13));
+                .withMessage(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_13));
     }