DATACMNS-1550 - Polishing.
Javadoc wording and formatting.
This commit is contained in:
@@ -64,7 +64,7 @@ public class AnnotationRevisionMetadata<N extends Number & Comparable<N>> 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<? extends Annotation> revisionNumberAnnotation,
|
||||
|
||||
@@ -73,10 +73,10 @@ public interface RevisionMetadata<N extends Number & Comparable<N>> {
|
||||
<T> 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<N extends Number & Comparable<N>> {
|
||||
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user