Merge pull request #344 from domaframework/support-record

nakamura-to · web-flow · commit fd672947baa8 · 2020-03-18T14:01:00.000+09:00
Support records
diff --git a/docs/domain.rst b/docs/domain.rst
@@ -45,6 +45,21 @@ The value ``new`` means that the object of annotated class is created with a con
       }
   }
 
+.. note::
+  In Java 14 and later version, you can annotate `records`_ with ``@Domain``:
+
+  .. code-block:: java
+
+    @Domain(valueType = String.class, accessorMethod = "value")
+    public record PhoneNumber(String value) {
+      public String getAreaCode() {
+        ...
+      }
+    }
+
+.. _records: https://openjdk.java.net/jeps/359
+
+
 Instantiation with a static factory method
 ------------------------------------------
 
diff --git a/docs/embeddable.rst b/docs/embeddable.rst
@@ -60,6 +60,19 @@ The above entity definition is equivalent to following one:
       String zip;
   }
 
+.. note::
+  In Java 14 and later version, you can annotate `records`_ with ``@Embeddable``:
+
+  .. code-block:: java
+
+    @Embeddable
+    public record Address(
+      String city,
+      String street,
+      @Column(name = "ZIP_CODE")String zip) {
+    }
+
+.. _records: https://openjdk.java.net/jeps/359
 
 Naming convention
 -----------------
diff --git a/docs/entity.rst b/docs/entity.rst
@@ -30,6 +30,19 @@ The following code snippet shows how to inherit other entity class:
       ...
   }
 
+.. note::
+  In Java 14 and later version, you can annotate `records`_ with ``@Entity``:
+
+  .. code-block:: java
+
+    @Entity
+    public record Employee(...) {
+    }
+
+  In the case, the entity is recognize as :ref:`immutable`
+  even though the immutable property of ``@Entity`` is ``false``.
+
+.. _records: https://openjdk.java.net/jeps/359
 
 Entity listeners
 ---------------------------
@@ -77,6 +90,8 @@ the naming convention is ignored.
 
 An entity subclass inherits parent's naming convention.
 
+.. _immutable:
+
 Immutable
 ----------------------------
 
diff --git a/src/main/java/org/seasar/doma/Entity.java b/src/main/java/org/seasar/doma/Entity.java
@@ -105,6 +105,9 @@
    * <p>If not specified and the entity class inherits another entity class, this value is inherited
    * from the parent entity class. The values must be consistent in the hierarchy.
    *
+   * <p>If not specified and the entity class is a record, the class is recognized as immutable even
+   * though this value is {@code false}.
+   *
    * @return whether the entity class is immutable
    */
   boolean immutable() default false;
diff --git a/src/main/java/org/seasar/doma/internal/apt/cttype/CtTypes.java b/src/main/java/org/seasar/doma/internal/apt/cttype/CtTypes.java
@@ -52,6 +52,7 @@
 import org.seasar.doma.internal.apt.AptIllegalStateException;
 import org.seasar.doma.internal.apt.Context;
 import org.seasar.doma.internal.apt.annot.DomainConvertersAnnot;
+import org.seasar.doma.internal.apt.util.ElementKindUtil;
 import org.seasar.doma.jdbc.BatchResult;
 import org.seasar.doma.jdbc.Config;
 import org.seasar.doma.jdbc.PreparedSql;
@@ -347,7 +348,8 @@ private EntityCtType newEntityCtType(TypeMirror type) {
     }
     Name binaryName = ctx.getMoreElements().getBinaryName(typeElement);
     ClassName descClassName = ClassNames.newEntityDescClassName(binaryName);
-    return new EntityCtType(ctx, type, entity.immutable(), descClassName);
+    boolean immutable = ElementKindUtil.isRecord(typeElement.getKind()) || entity.immutable();
+    return new EntityCtType(ctx, type, immutable, descClassName);
   }
 
   private FunctionCtType newFunctionCtType(TypeMirror type) {
diff --git a/src/main/java/org/seasar/doma/internal/apt/meta/domain/DomainMetaFactory.java b/src/main/java/org/seasar/doma/internal/apt/meta/domain/DomainMetaFactory.java
@@ -29,6 +29,7 @@
 import org.seasar.doma.internal.apt.cttype.BasicCtType;
 import org.seasar.doma.internal.apt.def.TypeParametersDef;
 import org.seasar.doma.internal.apt.meta.TypeElementMetaFactory;
+import org.seasar.doma.internal.apt.util.ElementKindUtil;
 import org.seasar.doma.internal.util.StringUtil;
 import org.seasar.doma.message.Message;
 
@@ -129,15 +130,16 @@ public void validateAcceptNull(TypeElement classElement, DomainMeta domainMeta)
 
     @Override
     public void validateClass(TypeElement classElement, DomainMeta domainMeta) {
-      if (classElement.getKind() == ElementKind.CLASS) {
+      ElementKind kind = classElement.getKind();
+      if (kind == ElementKind.CLASS || ElementKindUtil.isRecord(kind)) {
         if (domainMeta.providesConstructor()
             && classElement.getModifiers().contains(Modifier.ABSTRACT)) {
           throw new AptException(Message.DOMA4132, classElement, new Object[] {});
         }
         if (classElement.getNestingKind().isNested()) {
           validateEnclosingElement(classElement);
         }
-      } else if (classElement.getKind() == ElementKind.ENUM) {
+      } else if (kind == ElementKind.ENUM) {
         if (domainMeta.providesConstructor()) {
           DomainAnnot domainAnnot = domainMeta.getDomainAnnot();
           throw new AptException(
@@ -150,7 +152,7 @@ public void validateClass(TypeElement classElement, DomainMeta domainMeta) {
         if (classElement.getNestingKind().isNested()) {
           validateEnclosingElement(classElement);
         }
-      } else if (classElement.getKind() == ElementKind.INTERFACE) {
+      } else if (kind == ElementKind.INTERFACE) {
         if (domainMeta.providesConstructor()) {
           throw new AptException(Message.DOMA4268, classElement, new Object[] {});
         }
diff --git a/src/main/java/org/seasar/doma/internal/apt/meta/entity/EmbeddableMetaFactory.java b/src/main/java/org/seasar/doma/internal/apt/meta/entity/EmbeddableMetaFactory.java
@@ -40,6 +40,7 @@
 import org.seasar.doma.internal.apt.annot.EmbeddableAnnot;
 import org.seasar.doma.internal.apt.annot.ValueAnnot;
 import org.seasar.doma.internal.apt.meta.TypeElementMetaFactory;
+import org.seasar.doma.internal.apt.util.ElementKindUtil;
 import org.seasar.doma.message.Message;
 
 public class EmbeddableMetaFactory implements TypeElementMetaFactory<EmbeddableMeta> {
@@ -98,7 +99,8 @@ protected static class DefaultStrategy implements Strategy {
 
     @Override
     public void validateClass(TypeElement embeddableElement, EmbeddableMeta embeddableMeta) {
-      if (embeddableElement.getKind() != ElementKind.CLASS) {
+      ElementKind kind = embeddableElement.getKind();
+      if (kind != ElementKind.CLASS && !ElementKindUtil.isRecord(kind)) {
         EmbeddableAnnot embeddableAnnot = embeddableMeta.getEmbeddableAnnot();
         throw new AptException(
             Message.DOMA4283,
diff --git a/src/main/java/org/seasar/doma/internal/apt/meta/entity/EntityMetaFactory.java b/src/main/java/org/seasar/doma/internal/apt/meta/entity/EntityMetaFactory.java
@@ -41,6 +41,7 @@
 import org.seasar.doma.internal.apt.annot.ValueAnnot;
 import org.seasar.doma.internal.apt.meta.TypeElementMetaFactory;
 import org.seasar.doma.internal.apt.util.AnnotationValueUtil;
+import org.seasar.doma.internal.apt.util.ElementKindUtil;
 import org.seasar.doma.jdbc.entity.EntityListener;
 import org.seasar.doma.jdbc.entity.NamingType;
 import org.seasar.doma.jdbc.entity.NullEntityListener;
@@ -126,6 +127,9 @@ private NamingType resolveNamingType(TypeElement classElement) {
   }
 
   private boolean resolveImmutable(TypeElement classElement, EntityAnnot entityAnnot) {
+    if (ElementKindUtil.isRecord(classElement.getKind())) {
+      return true;
+    }
     boolean result = false;
     List<Boolean> resolvedList = new ArrayList<>();
     for (AnnotationValue value : getEntityElementValueList(classElement, "immutable")) {
@@ -205,7 +209,8 @@ public void doClassElement(TypeElement classElement, EntityMeta entityMeta) {
 
     void validateClass(TypeElement classElement, EntityMeta entityMeta) {
       EntityAnnot entityAnnot = entityMeta.getEntityAnnot();
-      if (classElement.getKind() != ElementKind.CLASS) {
+      ElementKind kind = classElement.getKind();
+      if (kind != ElementKind.CLASS && !ElementKindUtil.isRecord(kind)) {
         throw new AptException(
             Message.DOMA4015, classElement, entityAnnot.getAnnotationMirror(), new Object[] {});
       }
diff --git a/src/main/java/org/seasar/doma/internal/apt/util/ElementKindUtil.java b/src/main/java/org/seasar/doma/internal/apt/util/ElementKindUtil.java
@@ -0,0 +1,20 @@
+package org.seasar.doma.internal.apt.util;
+
+import java.util.Arrays;
+import javax.lang.model.element.ElementKind;
+
+public final class ElementKindUtil {
+
+  private static final ElementKind RECORD =
+      Arrays.stream(ElementKind.values())
+          .filter(k -> "RECORD".equals(k.name()))
+          .findAny()
+          .orElse(null);
+
+  public static boolean isRecord(ElementKind kind) {
+    if (RECORD == null) {
+      return false;
+    }
+    return RECORD == kind;
+  }
+}
diff --git a/src/main/java/org/seasar/doma/message/Message.java b/src/main/java/org/seasar/doma/message/Message.java
@@ -376,7 +376,8 @@ public enum Message implements MessageResource {
   DOMA4011(
       "The annotation processing for the class \"{0}\" is failed. The cause is as follows: {1}"),
   DOMA4014("Cannot annotate the type with @Dao because the type isn''t an interface."),
-  DOMA4015("Cannot annotate the type with @Entity because the type isn''t a class."),
+  DOMA4015(
+      "Cannot annotate the type with @Entity because the type is neither a class nor a record."),
   DOMA4016(
       "An unexpected error has occurred. It may be a bug in the Doma framework. Report the following stacktrace: {0}"),
   DOMA4017("The DAO interface must be a top level interface."),
@@ -464,7 +465,7 @@ public enum Message implements MessageResource {
   DOMA4104(
       "The accessor method \"{0}\" is not found. "
           + "The method must have the return type \"{1}\" and must be non-private and non-args."),
-  DOMA4105("You can annotate only classes, interfaces and enums with @Domain"),
+  DOMA4105("You can annotate only classes, interfaces, enums and records with @Domain"),
   DOMA4106(
       "The factory method　\"{0}\" is not found. "
           + "The method must have the return type \"{1}\" and the parameter type \"{2}\" and must be non-private and static. "
@@ -803,7 +804,7 @@ public enum Message implements MessageResource {
   DOMA4281(
       "The number, type and name of the constructor parameters must correspond to "
           + "those of persistent fields in the immutable entity class."),
-  DOMA4283("You can annotated only classes with @Embeddable."),
+  DOMA4283("You can annotate only classes and records with @Embeddable."),
   DOMA4285("The embeddable class must not have a type parameter."),
   DOMA4286("The fields of the embeddable class cannot be annotated with @OriginalStates."),
   DOMA4288("The annotation \"{0}\" competes with the annotation \"{1}\"."),
diff --git a/src/test/java/org/seasar/doma/internal/apt/util/ElementKindUtilTest.java b/src/test/java/org/seasar/doma/internal/apt/util/ElementKindUtilTest.java
@@ -0,0 +1,14 @@
+package org.seasar.doma.internal.apt.util;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import javax.lang.model.element.ElementKind;
+import org.junit.jupiter.api.Test;
+
+class ElementKindUtilTest {
+
+  @Test
+  void isRecord() {
+    assertFalse(ElementKindUtil.isRecord(ElementKind.CLASS));
+  }
+}
