Revision meta data

modules/basic/src/main/java/com/devonfw/module/basic/common/api/RevisionMetadata.java

@@ -0,0 +1,38 @@
+/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0 */
+package com.devonfw.module.basic.common.api;
+
+import java.util.Date;
+
+/**
+ * This is the interface for the metadata associated with a
+ * {@link com.devonfw.module.basic.common.api.entity.RevisionedEntity#getRevision() historic revision} of an
+ * {@link com.devonfw.module.basic.common.api.entity.RevisionedEntity revisioned entity}.
+ *
+ * @since 3.2.0
+ */
+public interface RevisionMetadata {
+
+  /**
+   * This method gets the {@link com.devonfw.module.basic.common.api.entity.RevisionedEntity#getRevision() revision
+   * number}.
+   *
+   * @return the revision number.
+   */
+  Number getRevision();
+
+  /**
+   * This method gets the date when this revision was created (closed).
+   *
+   * @return the date of completion or {@code null} if the according entity is the latest revision.
+   */
+  Date getDate();
+
+  /**
+   * This method gets the identifier (login) of the author who created this revision.
+   *
+   * @return the author. May be {@code null} (if committed outside user scope).
+   */
+  String getAuthor();
+
+}

modules/basic/src/main/java/com/devonfw/module/basic/common/api/RevisionMetadataType.java

@@ -0,0 +1,54 @@
+package com.devonfw.module.basic.common.api;
+
+import java.util.Date;
+
+/**
+ * Implementation of {@link RevisionMetadata} as immutable type.
+ */
+public class RevisionMetadataType implements RevisionMetadata {
+
+  private final Number revision;
+
+  private final Date date;
+
+  private final String author;
+
+  /**
+   * The constructor.
+   *
+   * @param revision the {@link #getRevision() revision}.
+   * @param date the {@link #getDate() date}.
+   * @param author the {@link #getAuthor() author}.
+   */
+  public RevisionMetadataType(Number revision, Date date, String author) {
+
+    this.revision = revision;
+    this.date = date;
+    this.author = author;
+  }
+
+  @Override
+  public Number getRevision() {
+
+    return this.revision;
+  }
+
+  @Override
+  public Date getDate() {
+
+    return this.date;
+  }
+
+  @Override
+  public String getAuthor() {
+
+    return this.author;
+  }
+
+  @Override
+  public String toString() {
+
+    return this.revision + "@" + this.date + " by " + this.author;
+  }
+
+}

modules/jpa-basic/src/main/java/com/devonfw/module/jpa/dataaccess/api/JpaHelper.java

@@ -2,6 +2,7 @@
 
 import java.util.Collection;
 
+import com.devonfw.module.basic.common.api.RevisionMetadataType;
 import com.devonfw.module.basic.common.api.entity.GenericEntity;
 import com.devonfw.module.basic.common.api.reference.GenericIdRef;
 import com.devonfw.module.basic.common.api.reference.Ref;
@@ -74,4 +75,20 @@ public static <E extends GenericEntity<?>, P extends E> void asEntities(Collecti
     }
   }
 
+  /**
+   * This is the newer implementation of RevisionMetadataType should be used with
+   * {@link com.devonfw.module.basic.common.api.RevisionMetadata}
+   *
+   * @param revEntity die {@link AdvancedRevisionEntity}.
+   * @return die Instanz von {@link RevisionMetadataType} bzw. {@code null} falls {@code revision} den Wert {@code null}
+   *         hat.
+   */
+  public static RevisionMetadataType asRevisionMetaData(AdvancedRevisionEntity revEntity) {
+
+    if (revEntity == null) {
+      return null;
+    }
+    return new RevisionMetadataType(revEntity.getId(), revEntity.getDate(), revEntity.getUserLogin());
+  }
+
 }

modules/jpa-basic/src/main/java/com/devonfw/module/jpa/dataaccess/api/RevisionMetadata.java

@@ -2,37 +2,16 @@
  * http://www.apache.org/licenses/LICENSE-2.0 */
 package com.devonfw.module.jpa.dataaccess.api;
 
-import java.util.Date;
-
 /**
- * This is the interface for the metadata associated with a
- * {@link com.devonfw.module.basic.common.api.entity.RevisionedEntity#getRevision() historic revision} of an
- * {@link com.devonfw.module.basic.common.api.entity.RevisionedEntity revisioned entity}.
+ * @deprecated use {@link com.devonfw.module.basic.common.api.RevisionMetadata} instead.
+ *
+ *             This is the interface for the metadata associated with a
+ *             {@link com.devonfw.module.basic.common.api.entity.RevisionedEntity#getRevision() historic revision} of an
+ *             {@link com.devonfw.module.basic.common.api.entity.RevisionedEntity revisioned entity}.
  *
  * @since 3.0.0
  */
-public interface RevisionMetadata {
-
-  /**
-   * This method gets the {@link com.devonfw.module.basic.common.api.entity.RevisionedEntity#getRevision() revision
-   * number}.
-   *
-   * @return the revision number.
-   */
-  Number getRevision();
-
-  /**
-   * This method gets the date when this revision was created (closed).
-   *
-   * @return the date of completion or {@code null} if the according entity is the latest revision.
-   */
-  Date getDate();
-
-  /**
-   * This method gets the identifier (login) of the author who created this revision.
-   *
-   * @return the author. May be {@code null} (if committed outside user scope).
-   */
-  String getAuthor();
+@Deprecated
+public interface RevisionMetadata extends com.devonfw.module.basic.common.api.RevisionMetadata {
 
 }

modules/jpa-basic/src/main/java/com/devonfw/module/jpa/dataaccess/api/RevisionMetadataType.java

@@ -3,8 +3,11 @@
 import java.util.Date;
 
 /**
- * Implementation of {@link RevisionMetadata} as immutable type.
+ * @deprecated use {@link com.devonfw.module.basic.common.api.RevisionMetadataType} instead.
+ *
+ *             Implementation of {@link RevisionMetadata} as immutable type.
  */
+@Deprecated
 public class RevisionMetadataType implements RevisionMetadata {
 
   private final Number revision;

modules/jpa-basic/src/main/java/com/devonfw/module/jpa/dataaccess/impl/LazyRevisionMetadata.java

@@ -6,8 +6,8 @@
 
 import javax.persistence.EntityManager;
 
+import com.devonfw.module.basic.common.api.RevisionMetadata;
 import com.devonfw.module.jpa.dataaccess.api.AdvancedRevisionEntity;
-import com.devonfw.module.jpa.dataaccess.api.RevisionMetadata;
 
 /**
  * This is a lazy implementation of the {@link RevisionMetadata} interface.

modules/jpa-envers/src/main/java/com/devonfw/module/jpa/dataaccess/api/GenericRevisionedDao.java

@@ -6,6 +6,7 @@
 
 import javax.persistence.PersistenceException;
 
+import com.devonfw.module.basic.common.api.RevisionMetadata;
 import com.devonfw.module.basic.common.api.entity.RevisionedEntity;
 import com.devonfw.module.basic.common.api.entity.RevisionedPersistenceEntity;
 

modules/jpa-envers/src/main/java/com/devonfw/module/jpa/dataaccess/base/AbstractGenericRevisionedDao.java

@@ -8,9 +8,9 @@
 import org.hibernate.envers.AuditReader;
 import org.hibernate.envers.AuditReaderFactory;
 
+import com.devonfw.module.basic.common.api.RevisionMetadata;
 import com.devonfw.module.basic.common.api.entity.RevisionedPersistenceEntity;
 import com.devonfw.module.jpa.dataaccess.api.GenericRevisionedDao;
-import com.devonfw.module.jpa.dataaccess.api.RevisionMetadata;
 import com.devonfw.module.jpa.dataaccess.impl.LazyRevisionMetadata;
 
 /**

modules/jpa-spring-data/src/main/java/com/devonfw/module/jpa/dataaccess/api/data/GenericRevisionedRepository.java

@@ -3,7 +3,7 @@
 import java.io.Serializable;
 import java.util.List;
 
-import com.devonfw.module.jpa.dataaccess.api.RevisionMetadata;
+import com.devonfw.module.basic.common.api.RevisionMetadata;
 
 /**
  * {@link GenericRepository} with additional support for {@link org.hibernate.envers.Audited}

modules/jpa-spring-data/src/main/java/com/devonfw/module/jpa/dataaccess/impl/data/GenericRevisionedRepositoryImpl.java

@@ -12,11 +12,11 @@
 import org.hibernate.envers.AuditReaderFactory;
 import org.springframework.data.jpa.repository.support.JpaEntityInformation;
 
+import com.devonfw.module.basic.common.api.RevisionMetadata;
 import com.devonfw.module.basic.common.api.entity.RevisionedEntity;
 import com.devonfw.module.jpa.dataaccess.api.AdvancedRevisionEntity;
+import com.devonfw.module.jpa.dataaccess.api.JpaHelper;
 import com.devonfw.module.jpa.dataaccess.api.QueryUtil;
-import com.devonfw.module.jpa.dataaccess.api.RevisionMetadata;
-import com.devonfw.module.jpa.dataaccess.api.RevisionMetadataType;
 import com.devonfw.module.jpa.dataaccess.api.data.GenericRevisionedRepository;
 import com.devonfw.module.jpa.dataaccess.impl.LazyRevisionMetadata;
 import com.querydsl.core.alias.Alias;
@@ -26,8 +26,8 @@
  * Implementation of {@link GenericRevisionedRepository}.
  *
  * @param <E> generic type of the managed {@link #getEntityClass() entity}.
- * @param <ID> generic type of the {@link com.devonfw.module.basic.common.api.entity.PersistenceEntity#getId() primary key}
- *        of the entity.
+ * @param <ID> generic type of the {@link com.devonfw.module.basic.common.api.entity.PersistenceEntity#getId() primary
+ *        key} of the entity.
  *
  * @since 3.0.0
  */
@@ -81,7 +81,7 @@ public List<RevisionMetadata> getRevisionHistoryMetadata(ID id, boolean lazy) {
       QueryUtil.get().whereIn(query, Alias.$(rev.getId()), (List<Long>) revList);
       query.orderBy(Alias.$(rev.getId()).asc());
       List<AdvancedRevisionEntity> resultList = query.fetch();
-      return resultList.stream().map(x -> RevisionMetadataType.of(x)).collect(Collectors.toList());
+      return resultList.stream().map(x -> JpaHelper.asRevisionMetaData(x)).collect(Collectors.toList());
     }
   }
 
@@ -98,7 +98,7 @@ public RevisionMetadata getLastRevisionHistoryMetadata(ID id) {
     if (revisionEntity == null) {
       throw new IllegalStateException("Could not find AdvancedRevisionEntity for ID '" + id + "'.");
     }
-    return RevisionMetadataType.of(revisionEntity);
+    return JpaHelper.asRevisionMetaData(revisionEntity);
   }
 
 }