Add documents

Author: nakamura-to

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
 ------------------------------------------
 

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
 -----------------

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
 ----------------------------
 

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;