Refactor requiresInListPadding to shouldRequireInListPadding

Renamed method for better consistency and readability across the codebase. Updated references and documentation to reflect the new method name, improving clarity in its purpose and usage.
domaframework · Jan 6, 2025 · 87f7bc0 · 87f7bc0
1 parent 0b878e8
commit 87f7bc0
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 11 deletions.
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/jdbc/sql/NodePreparedSqlBuilder.java b/doma-core/src/main/java/org/seasar/doma/internal/jdbc/sql/NodePreparedSqlBuilder.java
@@ -410,7 +410,7 @@ protected void handleIterableValueNode(
   }
 
   private <E> Iterable<E> applyInListPadding(ValueNode node, Iterable<E> values) {
-    if (node.getInNode() == null || !config.getSqlBuilderSettings().requiresInListPadding()) {
+    if (node.getInNode() == null || !config.getSqlBuilderSettings().shouldRequireInListPadding()) {
       return values;
     }
     Collection<E> valueCollection;

diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/SqlBuilderSettings.java b/doma-core/src/main/java/org/seasar/doma/jdbc/SqlBuilderSettings.java
@@ -50,11 +50,11 @@ default boolean shouldRemoveBlankLines() {
   }
 
   /**
-   * Indicates whether padding is required for the "IN" list clauses in SQL generation.
+   * Determines whether padding is required for elements in an "IN" list in SQL queries.
    *
-   * @return {@code true} if padding is required; {@code false} otherwise
+   * @return true if padding is required for elements in an "IN" list, false otherwise
    */
-  default boolean requiresInListPadding() {
+  default boolean shouldRequireInListPadding() {
     return false;
   }
 }
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/query/BuilderSupport.java b/doma-core/src/main/java/org/seasar/doma/jdbc/criteria/query/BuilderSupport.java
@@ -627,7 +627,7 @@ private void inTripleSubQuery(
     }
 
     private <E> Iterable<E> applyInListPadding(List<E> list) {
-      if (list.isEmpty() || !config.getSqlBuilderSettings().requiresInListPadding()) {
+      if (list.isEmpty() || !config.getSqlBuilderSettings().shouldRequireInListPadding()) {
         return list;
       }
       int size = list.size();

diff --git a/doma-core/src/test/java/org/seasar/doma/internal/jdbc/sql/SqlParserTest.java b/doma-core/src/test/java/org/seasar/doma/internal/jdbc/sql/SqlParserTest.java
@@ -52,7 +52,7 @@ public SqlBuilderSettings getSqlBuilderSettings() {
           return new SqlBuilderSettings() {
 
             @Override
-            public boolean requiresInListPadding() {
+            public boolean shouldRequireInListPadding() {
               return true;
             }
           };

diff --git a/doma-core/src/test/java/org/seasar/doma/jdbc/criteria/QueryDslSqlSelectTest.java b/doma-core/src/test/java/org/seasar/doma/jdbc/criteria/QueryDslSqlSelectTest.java
@@ -90,7 +90,7 @@ public SqlBuilderSettings getSqlBuilderSettings() {
           return new SqlBuilderSettings() {
 
             @Override
-            public boolean requiresInListPadding() {
+            public boolean shouldRequireInListPadding() {
               return true;
             }
           };

diff --git a/...gration-test-java/src/test/java/org/seasar/doma/it/criteria/QueryDslEntitySelectTest.java b/...gration-test-java/src/test/java/org/seasar/doma/it/criteria/QueryDslEntitySelectTest.java
@@ -443,7 +443,7 @@ public SqlBuilderSettings getSqlBuilderSettings() {
             return new SqlBuilderSettings() {
 
               @Override
-              public boolean requiresInListPadding() {
+              public boolean shouldRequireInListPadding() {
                 return true;
               }
             };
@@ -510,7 +510,7 @@ public SqlBuilderSettings getSqlBuilderSettings() {
             return new SqlBuilderSettings() {
 
               @Override
-              public boolean requiresInListPadding() {
+              public boolean shouldRequireInListPadding() {
                 return true;
               }
             };
@@ -549,7 +549,7 @@ public SqlBuilderSettings getSqlBuilderSettings() {
             return new SqlBuilderSettings() {
 
               @Override
-              public boolean requiresInListPadding() {
+              public boolean shouldRequireInListPadding() {
                 return true;
               }
             };

diff --git a/integration-test-java/src/test/java/org/seasar/doma/it/sql/SqlSelectTest.java b/integration-test-java/src/test/java/org/seasar/doma/it/sql/SqlSelectTest.java
@@ -48,7 +48,7 @@ public SqlBuilderSettings getSqlBuilderSettings() {
             return new SqlBuilderSettings() {
 
               @Override
-              public boolean requiresInListPadding() {
+              public boolean shouldRequireInListPadding() {
                 return true;
               }
             };