#365 - ENH: Add @DbComment with DDL generation of table and column comments

src/main/java/com/avaje/ebeaninternal/server/deploy/BeanDescriptor.java

@@ -155,6 +155,11 @@ public class BeanDescriptor<T> implements MetaBeanInfo, SpiBeanType<T> {
 
   private final String draftTable;
 
+  /**
+   * DB table comment.
+   */
+  private final String dbComment;
+
   /**
    * Set to true if read auditing is on for this bean type.
    */
@@ -397,6 +402,7 @@ public class BeanDescriptor<T> implements MetaBeanInfo, SpiBeanType<T> {
     this.baseTable = InternString.intern(deploy.getBaseTable());
     this.baseTableAsOf = deploy.getBaseTableAsOf();
     this.baseTableVersionsBetween = deploy.getBaseTableVersionsBetween();
+    this.dbComment = deploy.getDbComment();
     this.autoTunable = EntityType.ORM.equals(entityType) && (beanFinder == null);
 
     // helper object used to derive lists of properties
@@ -1936,6 +1942,13 @@ public class BeanDescriptor<T> implements MetaBeanInfo, SpiBeanType<T> {
     return EntityType.SQL.equals(entityType);
   }
 
+  /**
+   * Return the DB comment for the base table.
+   */
+  public String getDbComment() {
+    return dbComment;
+  }
+
   /**
    * Return the base table. Only properties mapped to the base table are by
    * default persisted.

src/main/java/com/avaje/ebeaninternal/server/deploy/BeanProperty.java

@@ -211,6 +211,11 @@ public class BeanProperty implements ElPropertyValue {
    */
   final String dbColumnDefn;
 
+  /**
+   * Database DDL column comment.
+   */
+  final String dbComment;
+
   /**
    * DB Constraint (typically check constraint on enum)
    */
@@ -298,6 +303,7 @@ public class BeanProperty implements ElPropertyValue {
     this.setter = deploy.getSetter();
 
     this.dbColumn = tableAliasIntern(descriptor, deploy.getDbColumn(), false, null);
+    this.dbComment = deploy.getDbComment();
     this.sqlFormulaJoin = InternString.intern(deploy.getSqlFormulaJoin());
     this.sqlFormulaSelect = InternString.intern(deploy.getSqlFormulaSelect());
     this.formula = sqlFormulaSelect != null;
@@ -377,6 +383,7 @@ public class BeanProperty implements ElPropertyValue {
     this.secondaryTableJoin = source.secondaryTableJoin;
     this.secondaryTableJoinPrefix = source.secondaryTableJoinPrefix;
 
+    this.dbComment = source.dbComment;
     this.dbBind = source.getDbBind();
     this.dbEncrypted = source.isDbEncrypted();
     this.dbEncryptedType = source.getDbEncryptedType();
@@ -999,6 +1006,13 @@ public class BeanProperty implements ElPropertyValue {
     return dbColumn;
   }
 
+  /**
+   * Return the comment for the associated DB column.
+   */
+  public String getDbComment() {
+    return dbComment;
+  }
+
   /**
    * Return the database jdbc data type this is mapped to.
    */

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

@@ -165,6 +165,9 @@ public class DeployBeanDescriptor<T> {
 
   private ChangeLogFilter changeLogFilter;
 
+  private String dbComment;
+
+
   /**
    * Construct the BeanDescriptor.
    */
@@ -207,6 +210,14 @@ public class DeployBeanDescriptor<T> {
     return readAuditing;
   }
 
+  public void setDbComment(String dbComment) {
+    this.dbComment = dbComment;
+  }
+
+  public String getDbComment() {
+    return dbComment;
+  }
+
   public void setDraftable() {
     draftable = true;
   }

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

@@ -193,6 +193,8 @@ public class DeployBeanProperty {
 
   private boolean softDelete;
 
+  private String dbComment;
+
   public DeployBeanProperty(DeployBeanDescriptor<?> desc, Class<?> propertyType, ScalarType<?> scalarType, ScalarTypeConverter<?, ?> typeConverter) {
     this.desc = desc;
     this.propertyType = propertyType;
@@ -898,4 +900,11 @@ public class DeployBeanProperty {
     return softDelete;
   }
 
+  public void setDbComment(String dbComment) {
+    this.dbComment = dbComment;
+  }
+
+  public String getDbComment() {
+    return dbComment;
+  }
 }

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

@@ -9,6 +9,7 @@ import javax.persistence.UniqueConstraint;
 
 import com.avaje.ebean.annotation.CacheStrategy;
 import com.avaje.ebean.annotation.CacheTuning;
+import com.avaje.ebean.annotation.DbComment;
 import com.avaje.ebean.annotation.Draftable;
 import com.avaje.ebean.annotation.DraftableElement;
 import com.avaje.ebean.annotation.EntityConcurrencyMode;
@@ -120,6 +121,11 @@ public class AnnotationClass extends AnnotationParser {
       descriptor.setHistorySupport();
     }
 
+    DbComment comment = cls.getAnnotation(DbComment.class);
+    if (comment != null) {
+      descriptor.setDbComment(comment.value());
+    }
+
     UpdateMode updateMode = cls.getAnnotation(UpdateMode.class);
     if (updateMode != null) {
       descriptor.setUpdateChangesOnly(updateMode.updateChangesOnly());

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

@@ -166,6 +166,10 @@ public class AnnotationFields extends AnnotationParser {
       prop.setSoftDelete();
     }
 
+    DbComment comment = get(prop, DbComment.class);
+    if (comment != null) {
+      prop.setDbComment(comment.value());
+    }
     DbJson dbJson = get(prop, DbJson.class);
     if (dbJson != null) {
       util.setDbJsonType(prop, dbJson);