Refactor the ReturningProperties interface and the implementations

Author: nakamura-to

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlDeleteStatement.java

@@ -61,7 +61,7 @@ private EntityqlDeleteStatement(
   }
 
   public Statement<Result<ENTITY>> returning(PropertyMetamodel<?>... properties) {
-    var returning = SpecificMetamodels.of(entityMetamodel, properties);
+    var returning = ReturningPropertyMetamodels.of(entityMetamodel, properties);
     return new EntityqlDeleteStatement<>(config, entityMetamodel, entity, settings, returning);
   }
 

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlInsertIntermediate.java

@@ -61,7 +61,7 @@ public EntityqlInsertTerminal<ENTITY> keys(PropertyMetamodel<?>... keys) {
   }
 
   public Statement<Result<ENTITY>> returning(PropertyMetamodel<?>... properties) {
-    var returning = SpecificMetamodels.of(entityMetamodel, properties);
+    var returning = ReturningPropertyMetamodels.of(entityMetamodel, properties);
     return new EntityqlInsertTerminal<>(
         config, entityMetamodel, entity, settings, duplicateKeyType, List.of(), returning);
   }

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlInsertTerminal.java

@@ -77,7 +77,7 @@ public EntityqlInsertTerminal(
   }
 
   public Statement<Result<ENTITY>> returning(PropertyMetamodel<?>... properties) {
-    var returning = SpecificMetamodels.of(entityMetamodel, properties);
+    var returning = ReturningPropertyMetamodels.of(entityMetamodel, properties);
     return new EntityqlInsertTerminal<>(
         config, entityMetamodel, entity, settings, duplicateKeyType, keys, returning);
   }

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlMultiInsertIntermediate.java

@@ -69,7 +69,7 @@ public EntityqlMultiInsertTerminal<ENTITY> keys(PropertyMetamodel<?>... keys) {
   }
 
   public Statement<MultiResult<ENTITY>> returning(PropertyMetamodel<?>... properties) {
-    var returning = SpecificMetamodels.of(entityMetamodel, properties);
+    var returning = ReturningPropertyMetamodels.of(entityMetamodel, properties);
     return new EntityqlMultiInsertTerminal<>(
         config, entityMetamodel, entities, settings, duplicateKeyType, List.of(), returning);
   }

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlMultiInsertTerminal.java

@@ -81,7 +81,7 @@ public EntityqlMultiInsertTerminal(
   }
 
   public Statement<MultiResult<ENTITY>> returning(PropertyMetamodel<?>... properties) {
-    var returning = SpecificMetamodels.of(entityMetamodel, properties);
+    var returning = ReturningPropertyMetamodels.of(entityMetamodel, properties);
     return new EntityqlMultiInsertTerminal<>(
         config, entityMetamodel, entities, settings, duplicateKeyType, keys, returning);
   }

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/EntityqlUpdateStatement.java

@@ -61,7 +61,7 @@ private EntityqlUpdateStatement(
   }
 
   public Statement<Result<ENTITY>> returning(PropertyMetamodel<?>... properties) {
-    var returning = SpecificMetamodels.of(entityMetamodel, properties);
+    var returning = ReturningPropertyMetamodels.of(entityMetamodel, properties);
     return new EntityqlUpdateStatement<>(config, entityMetamodel, entity, settings, returning);
   }
 

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/SpecificMetamodels.java renamed to doma-core/src/main/java/org/seasar/doma/jdbc/criteria/statement/ReturningPropertyMetamodels.java

@@ -27,9 +27,16 @@
 import org.seasar.doma.jdbc.query.ReturningProperties;
 import org.seasar.doma.message.Message;
 
-record SpecificMetamodels(
-    EntityMetamodel<?> entityMetamodel, List<PropertyMetamodel<?>> propertyMetamodels)
-    implements ReturningProperties {
+class ReturningPropertyMetamodels implements ReturningProperties {
+
+  private final EntityMetamodel<?> entityMetamodel;
+  private final List<? extends EntityPropertyType<?, ?>> propertyTypes;
+
+  private ReturningPropertyMetamodels(
+      EntityMetamodel<?> entityMetamodel, List<? extends EntityPropertyType<?, ?>> propertyTypes) {
+    this.entityMetamodel = Objects.requireNonNull(entityMetamodel);
+    this.propertyTypes = Objects.requireNonNull(propertyTypes);
+  }
 
   @Override
   public List<? extends EntityPropertyType<?, ?>> resolve(EntityType<?> entityType) {
@@ -40,7 +47,7 @@ record SpecificMetamodels(
           entityMetamodel.asType().getEntityClass().getName(),
           entityType.getEntityClass().getName());
     }
-    return propertyMetamodels.stream().map(PropertyMetamodel::asType).toList();
+    return propertyTypes;
   }
 
   static ReturningProperties of(
@@ -57,6 +64,7 @@ static ReturningProperties of(
             Message.DOMA6012, p.getName(), i, entityMetamodel.asType().getEntityClass().getName());
       }
     }
-    return new SpecificMetamodels(entityMetamodel, Arrays.stream(propertyMetamodels).toList());
+    return new ReturningPropertyMetamodels(
+        entityMetamodel, Arrays.stream(propertyMetamodels).map(PropertyMetamodel::asType).toList());
   }
 }

doma-core/src/main/java/org/seasar/doma/jdbc/query/ReturningProperties.java

@@ -15,59 +15,48 @@
  */
 package org.seasar.doma.jdbc.query;
 
+import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
 import org.seasar.doma.jdbc.entity.EntityPropertyType;
 import org.seasar.doma.jdbc.entity.EntityType;
 
+/** Represents returning properties. */
 public interface ReturningProperties {
 
-  ReturningProperties NONE =
-      entityType -> {
-        throw new UnsupportedOperationException("unsupported");
-      };
+  /** A predefined instance of {@link ReturningProperties} that represents no properties. */
+  ReturningProperties NONE = __ -> Collections.emptyList();
 
+  /** A predefined instance of {@link ReturningProperties} that represents all properties. */
   ReturningProperties ALL =
-      entityType -> {
-        Objects.requireNonNull(entityType);
-        return entityType.getEntityPropertyTypes();
+      it -> {
+        Objects.requireNonNull(it);
+        return it.getEntityPropertyTypes();
       };
 
+  /**
+   * Checks if the current {@code ReturningProperties} instance represents no properties.
+   *
+   * @return {@code true} if this instance is equal to {@code NONE}, otherwise {@code false}
+   */
   default boolean isNone() {
     return this == NONE;
   }
 
-  List<? extends EntityPropertyType<?, ?>> resolve(EntityType<?> entityType);
-
-  class SpecificNames implements ReturningProperties {
-
-    private final List<String> includedNames;
-    private final List<String> excludedNames;
-
-    public SpecificNames(List<String> includedNames, List<String> excludedNames) {
-      this.includedNames = Objects.requireNonNull(includedNames);
-      this.excludedNames = Objects.requireNonNull(excludedNames);
-    }
-
-    @Override
-    public List<? extends EntityPropertyType<?, ?>> resolve(EntityType<?> entityType) {
-      Objects.requireNonNull(entityType);
-      var includedPropertyTypes = extractIncludedPropertyTypes(entityType);
-      var excludedPropertyTypes = extractExcludedPropertyTypes(entityType);
-      return includedPropertyTypes.stream()
-          .filter(it -> !excludedPropertyTypes.contains(it))
-          .toList();
-    }
-
-    private List<? extends EntityPropertyType<?, ?>> extractIncludedPropertyTypes(
-        EntityType<?> entityType) {
-      var list = includedNames.stream().map(entityType::getEntityPropertyType).toList();
-      return list.isEmpty() ? entityType.getEntityPropertyTypes() : list;
-    }
-
-    private List<? extends EntityPropertyType<?, ?>> extractExcludedPropertyTypes(
-        EntityType<?> entityType) {
-      return excludedNames.stream().map(entityType::getEntityPropertyType).toList();
-    }
+  /**
+   * Checks if the current {@code ReturningProperties} instance represents all properties.
+   *
+   * @return {@code true} if this instance is equal to {@code ALL}, otherwise {@code false}
+   */
+  default boolean isAll() {
+    return this == ALL;
   }
+
+  /**
+   * Resolves a list of entity property types for the given entity type.
+   *
+   * @param entityType the entity type for which to resolve property types
+   * @return a list of entity property types associated with the given entity type
+   */
+  List<? extends EntityPropertyType<?, ?>> resolve(EntityType<?> entityType);
 }

doma-core/src/main/java/org/seasar/doma/jdbc/query/ReturningPropertyNames.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright Doma 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.seasar.doma.jdbc.query;
+
+import java.util.List;
+import java.util.Objects;
+import org.seasar.doma.jdbc.entity.EntityPropertyType;
+import org.seasar.doma.jdbc.entity.EntityType;
+
+public class ReturningPropertyNames implements ReturningProperties {
+
+  private final List<String> includedNames;
+  private final List<String> excludedNames;
+
+  private ReturningPropertyNames(List<String> includedNames, List<String> excludedNames) {
+    this.includedNames = Objects.requireNonNull(includedNames);
+    this.excludedNames = Objects.requireNonNull(excludedNames);
+  }
+
+  @Override
+  public List<? extends EntityPropertyType<?, ?>> resolve(EntityType<?> entityType) {
+    Objects.requireNonNull(entityType);
+    var includedPropertyTypes = extractIncludedPropertyTypes(entityType);
+    var excludedPropertyTypes = extractExcludedPropertyTypes(entityType);
+    return includedPropertyTypes.stream()
+        .filter(it -> !excludedPropertyTypes.contains(it))
+        .toList();
+  }
+
+  private List<? extends EntityPropertyType<?, ?>> extractIncludedPropertyTypes(
+      EntityType<?> entityType) {
+    var list = includedNames.stream().map(entityType::getEntityPropertyType).toList();
+    return list.isEmpty() ? entityType.getEntityPropertyTypes() : list;
+  }
+
+  private List<? extends EntityPropertyType<?, ?>> extractExcludedPropertyTypes(
+      EntityType<?> entityType) {
+    return excludedNames.stream().map(entityType::getEntityPropertyType).toList();
+  }
+
+  public static ReturningProperties of(List<String> includedNames, List<String> excludedNames) {
+    if (includedNames.isEmpty() && excludedNames.isEmpty()) {
+      return ALL;
+    }
+    return new ReturningPropertyNames(includedNames, excludedNames);
+  }
+}

doma-core/src/test/java/org/seasar/doma/jdbc/criteria/statement/SpecificMetamodelsTest.java renamed to doma-core/src/test/java/org/seasar/doma/jdbc/criteria/statement/ReturningPropertyMetamodelsTest.java

@@ -23,27 +23,27 @@
 import org.seasar.doma.jdbc.criteria.entity.Emp_;
 import org.seasar.doma.message.Message;
 
-class SpecificMetamodelsTest {
+class ReturningPropertyMetamodelsTest {
 
   @Test
   void of() {
     var e = new Emp_();
-    assertNotNull(SpecificMetamodels.of(e, e.id));
+    assertNotNull(ReturningPropertyMetamodels.of(e, e.id));
   }
 
   @Test
   void of_error() {
     var e = new Emp_();
     var d = new Dept_();
-    var ex = assertThrows(DomaException.class, () -> SpecificMetamodels.of(e, d.name));
+    var ex = assertThrows(DomaException.class, () -> ReturningPropertyMetamodels.of(e, d.name));
     assertEquals(Message.DOMA6012, ex.getMessageResource());
     System.out.println(ex.getMessage());
   }
 
   @Test
   void resolve() {
     var e = new Emp_();
-    var returning = SpecificMetamodels.of(e, e.id);
+    var returning = ReturningPropertyMetamodels.of(e, e.id);
     var list = returning.resolve(e.asType());
     assertEquals(1, list.size());
     assertEquals(e.id.asType(), list.get(0));
@@ -53,7 +53,7 @@ void resolve() {
   void resolve_error() {
     var e = new Emp_();
     var d = new Dept_();
-    var returning = SpecificMetamodels.of(e, e.id);
+    var returning = ReturningPropertyMetamodels.of(e, e.id);
     var ex = assertThrows(DomaException.class, () -> returning.resolve(d.asType()));
     assertEquals(Message.DOMA6013, ex.getMessageResource());
     System.out.println(ex.getMessage());