Javadocs Version enum in Command

neo4j · Sep 4, 2017 · b272746 · b272746
1 parent 8eb8f7a
commit b272746
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/community/kernel/src/main/java/org/neo4j/kernel/impl/transaction/command/Command.java b/community/kernel/src/main/java/org/neo4j/kernel/impl/transaction/command/Command.java
@@ -91,8 +91,15 @@ public static Mode fromRecordState( AbstractBaseRecord record )
         }
     }
 
+    /**
+     * Many commands have before/after versions of their records. In some scenarios there's a need
+     * to parameterize which of those to work with.
+     */
     public enum Version
     {
+        /**
+         * The "before" version of a command's record. I.e. the record how it looked before changes took place.
+         */
         BEFORE
         {
             @Override
@@ -101,6 +108,9 @@ <RECORD extends AbstractBaseRecord> RECORD select( BaseCommand<RECORD> command )
                 return command.getBefore();
             }
         },
+        /**
+         * The "after" version of a command's record. I.e. the record how it looks after changes took place.
+         */
         AFTER
         {
             @Override
@@ -110,6 +120,12 @@ <RECORD extends AbstractBaseRecord> RECORD select( BaseCommand<RECORD> command )
             }
         };
 
+        /**
+         * Selects one of the versions of a {@link BaseCommand}.
+         *
+         * @param command command to select a version from.
+         * @return the specific record version in this command.
+         */
         abstract <RECORD extends AbstractBaseRecord> RECORD select( BaseCommand<RECORD> command );
     }