#348 - ENH: Add @WhenCreated and @WhenModified ... as alias to existing @CreatedTimestamp and @UpdatedTimstamp

src/main/java/com/avaje/ebean/annotation/WhenCreated.java

@@ -0,0 +1,38 @@
+package com.avaje.ebean.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * For a timestamp property that is set to the datetime when the entity is
+ * created/inserted.
+ * <p>
+ * This is effectively an alias for @CreatedTimestamp and added to hint
+ * towards a better naming convention (WhenCreated, WhenModified).
+ * </p>
+ * <p>
+ * An alternative to using this annotation would be to use insertable=false,
+ * updateable=false with @Column and have the DB insert the current time
+ * (default value on the DB column is SYSTIME etc).
+ * </p>
+ * <p>
+ * The downside to this approach is that the inserted entity does not have the
+ * timestamp value after the insert has occurred. You need to fetch the entity
+ * back to get the inserted timestamp if you want to used it.
+ * </p>
+ *
+ * <h3>Example:</h3>
+ * <pre>{@code
+ *
+ *   @WhenCreated
+ *   Timestamp whenCreated;
+ *
+ * }</pre>
+ */
+@Target({ ElementType.FIELD, ElementType.METHOD })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface WhenCreated {
+
+}

src/main/java/com/avaje/ebean/annotation/WhenModified.java

@@ -0,0 +1,20 @@
+package com.avaje.ebean.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * For a timestamp property that is set to the datetime when the entity was last modified.
+ * <p>
+ * This is effectively an alias for @UpdatedTimestamp and added to hint
+ * towards a better naming convention (WhenCreated, WhenModified).
+ * </p>
+ * </p>
+ */
+@Target({ ElementType.FIELD, ElementType.METHOD })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface WhenModified {
+
+}

src/main/java/com/avaje/ebeaninternal/server/deploy/meta/DeployBeanProperty.java

@@ -13,6 +13,8 @@ import javax.persistence.Version;
 
 import com.avaje.ebean.annotation.CreatedTimestamp;
 import com.avaje.ebean.annotation.UpdatedTimestamp;
+import com.avaje.ebean.annotation.WhenCreated;
+import com.avaje.ebean.annotation.WhenModified;
 import com.avaje.ebean.config.ScalarTypeConverter;
 import com.avaje.ebean.config.dbplatform.DbEncrypt;
 import com.avaje.ebean.config.dbplatform.DbEncryptFunction;
@@ -244,9 +246,9 @@ public class DeployBeanProperty {
       return ID_ORDER;
     } else if (undirectionalShadow) {
       return UNIDIRECTIONAL_ORDER;
-    } else if (field.getAnnotation(CreatedTimestamp.class) != null) {
+    } else if (field.getAnnotation(WhenCreated.class) != null || field.getAnnotation(CreatedTimestamp.class) != null) {
       return AUDITCOLUMN_ORDER;
-    } else if (field.getAnnotation(UpdatedTimestamp.class) != null) {
+    } else if (field.getAnnotation(WhenModified.class) != null || field.getAnnotation(UpdatedTimestamp.class) != null) {
       return AUDITCOLUMN_ORDER;
     } else if (field.getAnnotation(Version.class) != null) {
       return VERSIONCOLUMN_ORDER;

src/main/java/com/avaje/ebeaninternal/server/deploy/parse/AnnotationFields.java

@@ -12,6 +12,8 @@ import com.avaje.ebean.annotation.HistoryExclude;
 import com.avaje.ebean.annotation.Index;
 import com.avaje.ebean.annotation.JsonIgnore;
 import com.avaje.ebean.annotation.UpdatedTimestamp;
+import com.avaje.ebean.annotation.WhenCreated;
+import com.avaje.ebean.annotation.WhenModified;
 import com.avaje.ebean.config.EncryptDeploy;
 import com.avaje.ebean.config.EncryptDeploy.Mode;
 import com.avaje.ebean.config.dbplatform.DbEncrypt;
@@ -208,13 +210,11 @@ public class AnnotationFields extends AnnotationParser {
       prop.setFetchType(defaultLobFetchType);
     }
 
-    CreatedTimestamp ct = get(prop, CreatedTimestamp.class);
-    if (ct != null) {
+    if (get(prop, WhenCreated.class) != null || get(prop, CreatedTimestamp.class) != null) {
       generatedPropFactory.setInsertTimestamp(prop);
     }
 
-    UpdatedTimestamp ut = get(prop, UpdatedTimestamp.class);
-    if (ut != null) {
+    if (get(prop, WhenModified.class) != null || get(prop, UpdatedTimestamp.class) != null) {
       generatedPropFactory.setUpdateTimestamp(prop);
     }
 

src/test/java/com/avaje/tests/generated/TestGeneratedProperties.java

@@ -18,6 +18,8 @@ public class TestGeneratedProperties extends BaseTestCase {
 
     assertNotNull(bean.getId());
     assertNotNull(bean.getVersion());
+    assertNotNull(bean.getWhenCreated());
+    assertNotNull(bean.getWhenModified());
     assertNotNull(bean.getTsCreated());
     assertNotNull(bean.getTsUpdated());
     assertNotNull(bean.getLdtCreated());

src/test/java/com/avaje/tests/model/BaseModel.java

@@ -7,8 +7,8 @@ import javax.persistence.MappedSuperclass;
 import javax.persistence.Version;
 
 import com.avaje.ebean.Model;
-import com.avaje.ebean.annotation.CreatedTimestamp;
-import com.avaje.ebean.annotation.UpdatedTimestamp;
+import com.avaje.ebean.annotation.WhenCreated;
+import com.avaje.ebean.annotation.WhenModified;
 
 @MappedSuperclass
 public class BaseModel extends Model {
@@ -19,11 +19,11 @@ public class BaseModel extends Model {
   @Version
   Long version;
   
-  @CreatedTimestamp
+  @WhenCreated
   Timestamp whenCreated;
 
-  @UpdatedTimestamp
-  Timestamp whenUpdated;
+  @WhenModified
+  Timestamp whenModified;
 
   public Long getId() {
     return id;
@@ -49,12 +49,12 @@ public class BaseModel extends Model {
     this.whenCreated = whenCreated;
   }
 
-  public Timestamp getWhenUpdated() {
-    return whenUpdated;
+  public Timestamp getWhenModified() {
+    return whenModified;
   }
 
-  public void setWhenUpdated(Timestamp whenUpdated) {
-    this.whenUpdated = whenUpdated;
+  public void setWhenModified(Timestamp whenModified) {
+    this.whenModified = whenModified;
   }
 
 }

src/test/java/com/avaje/tests/model/EGenProps.java

@@ -2,6 +2,8 @@ package com.avaje.tests.model;
 
 import com.avaje.ebean.annotation.CreatedTimestamp;
 import com.avaje.ebean.annotation.UpdatedTimestamp;
+import com.avaje.ebean.annotation.WhenCreated;
+import com.avaje.ebean.annotation.WhenModified;
 
 import javax.persistence.Entity;
 import javax.persistence.Id;
@@ -22,6 +24,12 @@ public class EGenProps {
   @Version
   Long version;
 
+  @WhenCreated
+  Timestamp whenCreated;
+
+  @WhenModified
+  Timestamp whenModified;
+
   @CreatedTimestamp
   Timestamp tsCreated;
 
@@ -76,6 +84,22 @@ public class EGenProps {
     this.version = version;
   }
 
+  public Timestamp getWhenCreated() {
+    return whenCreated;
+  }
+
+  public void setWhenCreated(Timestamp whenCreated) {
+    this.whenCreated = whenCreated;
+  }
+
+  public Timestamp getWhenModified() {
+    return whenModified;
+  }
+
+  public void setWhenModified(Timestamp whenModified) {
+    this.whenModified = whenModified;
+  }
+
   public Timestamp getTsCreated() {
     return tsCreated;
   }

src/test/java/com/avaje/tests/model/basic/BasicDomain.java

@@ -7,8 +7,8 @@ import javax.persistence.Id;
 import javax.persistence.MappedSuperclass;
 import javax.persistence.Version;
 
-import com.avaje.ebean.annotation.CreatedTimestamp;
-import com.avaje.ebean.annotation.UpdatedTimestamp;
+import com.avaje.ebean.annotation.WhenCreated;
+import com.avaje.ebean.annotation.WhenModified;
 
 @MappedSuperclass
 public class BasicDomain implements Serializable {
@@ -18,10 +18,10 @@ public class BasicDomain implements Serializable {
 	@Id
 	Integer id;
 
-	@CreatedTimestamp
+	@WhenCreated
 	Timestamp cretime;
 	
-	@UpdatedTimestamp
+	@WhenModified
 	Timestamp updtime;
 
 	@Version

src/test/java/com/avaje/tests/model/basic/Order.java

@@ -22,8 +22,8 @@ import javax.persistence.Version;
 import javax.validation.constraints.NotNull;
 import javax.xml.bind.annotation.XmlType;
 
-import com.avaje.ebean.annotation.CreatedTimestamp;
 import com.avaje.ebean.annotation.Formula;
+import com.avaje.ebean.annotation.WhenCreated;
 import com.avaje.ebean.annotation.Where;
 
 /**
@@ -90,7 +90,7 @@ public class Order implements Serializable {
   @Column(name = "name", table = "o_customer")
   String customerName;
 
-  @CreatedTimestamp
+  @WhenCreated
   Timestamp cretime;
 
   @Version

src/test/java/com/avaje/tests/model/onetoone/TestOneToOneOptionalRelationship.java

@@ -69,7 +69,7 @@ public class TestOneToOneOptionalRelationship extends BaseTestCase {
     Assert.assertTrue(sql.contains(" from oto_account t0 left outer join oto_user t1 on t1.account_id = t0.id  where t0.id = ?"));
    
     String lazyLoadSql = loggedSql.get(1);
-    Assert.assertTrue(lazyLoadSql.contains("select t0.id c0, t0.name c1, t0.version c2, t0.when_created c3, t0.when_updated c4, t0.account_id c5 from oto_user t0 where t0.id = ?"));
+    Assert.assertTrue(lazyLoadSql.contains("select t0.id c0, t0.name c1, t0.version c2, t0.when_created c3, t0.when_modified c4, t0.account_id c5 from oto_user t0 where t0.id = ?"));
   }