From 736d1474468aa0359f179943777d679357a443b7 Mon Sep 17 00:00:00 2001 From: Oliver Drotbohm Date: Mon, 1 Jul 2019 15:33:04 +0200 Subject: [PATCH] DATACMNS-1550 - Polishing. Javadoc wording and formatting. --- .../data/history/AnnotationRevisionMetadata.java | 2 +- .../data/history/RevisionMetadata.java | 14 +++++++++----- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/src/main/java/org/springframework/data/history/AnnotationRevisionMetadata.java b/src/main/java/org/springframework/data/history/AnnotationRevisionMetadata.java index d8cdb1fe2..5b2f199ea 100755 --- a/src/main/java/org/springframework/data/history/AnnotationRevisionMetadata.java +++ b/src/main/java/org/springframework/data/history/AnnotationRevisionMetadata.java @@ -64,7 +64,7 @@ public class AnnotationRevisionMetadata> implem * @param entity must not be {@literal null}. * @param revisionNumberAnnotation must not be {@literal null}. * @param revisionTimeStampAnnotation must not be {@literal null}. - * @param revisionType Must not be {@literal null}. + * @param revisionType must not be {@literal null}. * @since 2.2.0 */ public AnnotationRevisionMetadata(Object entity, Class revisionNumberAnnotation, diff --git a/src/main/java/org/springframework/data/history/RevisionMetadata.java b/src/main/java/org/springframework/data/history/RevisionMetadata.java index ce5392c7d..8011f3472 100755 --- a/src/main/java/org/springframework/data/history/RevisionMetadata.java +++ b/src/main/java/org/springframework/data/history/RevisionMetadata.java @@ -73,10 +73,10 @@ public interface RevisionMetadata> { T getDelegate(); /** - * Returns the {@link RevisionType} of this change. If the {@link RevisionType} cannot be determined this method + * Returns the {@link RevisionType} of this change. If the {@link RevisionType} cannot be determined, this method * returns {@link RevisionType#UNKNOWN}. - * - * @return Guaranteed to be not {@literal null}. + * + * @return will never be {@literal null}. * @since 2.2.0 */ default RevisionType getRevisionType() { @@ -85,17 +85,21 @@ public interface RevisionMetadata> { /** * The type of a {@link Revision}. - * + * * @author Jens Schauder * @since 2.2.0 */ enum RevisionType { - /** Fallback when the type of a revision cannot be determined. */ + + /** Fallback if the type of a revision cannot be determined. */ UNKNOWN, + /** Creation of an instance */ INSERT, + /** Change of an instance */ UPDATE, + /** Deletion of an instance */ DELETE }