Rename ValidateOnOpenMode to ValidateOnOpenModePages #190

Author: greenrobot

objectbox-java/src/main/java/io/objectbox/BoxStoreBuilder.java

@@ -35,8 +35,8 @@
 import io.objectbox.annotation.apihint.Internal;
 import io.objectbox.config.DebugFlags;
 import io.objectbox.config.FlatStoreOptions;
-import io.objectbox.config.ValidateOnOpenMode;
 import io.objectbox.config.ValidateOnOpenModeKv;
+import io.objectbox.config.ValidateOnOpenModePages;
 import io.objectbox.exception.DbException;
 import io.objectbox.exception.DbFullException;
 import io.objectbox.exception.DbMaxDataSizeExceededException;
@@ -414,13 +414,14 @@ public BoxStoreBuilder usePreviousCommit() {
      * See also {@link #validateOnOpenPageLimit(long)} to fine-tune this check and {@link #validateOnOpenKv(short)} for
      * additional checks.
      *
-     * @param validateOnOpenMode One of {@link ValidateOnOpenMode}.
+     * @param validateOnOpenModePages One of {@link ValidateOnOpenModePages}.
      */
-    public BoxStoreBuilder validateOnOpen(short validateOnOpenMode) {
-        if (validateOnOpenMode < ValidateOnOpenMode.None || validateOnOpenMode > ValidateOnOpenMode.Full) {
-            throw new IllegalArgumentException("Must be one of ValidateOnOpenMode");
+    public BoxStoreBuilder validateOnOpen(short validateOnOpenModePages) {
+        if (validateOnOpenModePages < ValidateOnOpenModePages.None
+                || validateOnOpenModePages > ValidateOnOpenModePages.Full) {
+            throw new IllegalArgumentException("Must be one of ValidateOnOpenModePages");
         }
-        this.validateOnOpenModePages = validateOnOpenMode;
+        this.validateOnOpenModePages = validateOnOpenModePages;
         return this;
     }
 
@@ -429,10 +430,12 @@ public BoxStoreBuilder validateOnOpen(short validateOnOpenMode) {
      * This is measured in "pages" with a page typically holding 4000.
      * Usually a low number (e.g. 1-20) is sufficient and does not impact startup performance significantly.
      * <p>
-     * This can only be used with {@link ValidateOnOpenMode#Regular} and {@link ValidateOnOpenMode#WithLeaves}.
+     * This can only be used with {@link ValidateOnOpenModePages#Regular} and
+     * {@link ValidateOnOpenModePages#WithLeaves}.
      */
     public BoxStoreBuilder validateOnOpenPageLimit(long limit) {
-        if (validateOnOpenModePages != ValidateOnOpenMode.Regular && validateOnOpenModePages != ValidateOnOpenMode.WithLeaves) {
+        if (validateOnOpenModePages != ValidateOnOpenModePages.Regular &&
+                validateOnOpenModePages != ValidateOnOpenModePages.WithLeaves) {
             throw new IllegalStateException("Must call validateOnOpen(mode) with mode Regular or WithLeaves first");
         }
         if (limit < 1) {

objectbox-java/src/main/java/io/objectbox/config/ValidateOnOpenMode.java renamed to objectbox-java/src/main/java/io/objectbox/config/ValidateOnOpenModePages.java

@@ -22,8 +22,8 @@
  * Defines if and how the database is checked for structural consistency (pages) when opening it.
  */
 @SuppressWarnings("unused")
-public final class ValidateOnOpenMode {
-  private ValidateOnOpenMode() { }
+public final class ValidateOnOpenModePages {
+  private ValidateOnOpenModePages() { }
   /**
    * Not a real type, just best practice (e.g. forward compatibility)
    */

objectbox-java/src/main/java/io/objectbox/model/ValidateOnOpenMode.java

@@ -21,7 +21,7 @@
 /**
  * Defines if and how the database is checked for structural consistency (pages) when opening it.
  *
- * @deprecated This class has moved to the config package, use {@link io.objectbox.config.ValidateOnOpenMode} instead.
+ * @deprecated This class has moved to the config package, use {@link io.objectbox.config.ValidateOnOpenModePages} instead.
  */
 @Deprecated
 @SuppressWarnings("unused")

tests/objectbox-java-test/src/test/java/io/objectbox/BoxStoreValidationTest.java

@@ -21,7 +21,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 
-import io.objectbox.config.ValidateOnOpenMode;
+import io.objectbox.config.ValidateOnOpenModePages;
 import io.objectbox.exception.FileCorruptException;
 import io.objectbox.exception.PagesCorruptException;
 import org.greenrobot.essentials.io.IoUtils;
@@ -62,7 +62,7 @@ public void validateOnOpen() {
         // Then re-open database with validation and ensure db is operational
         builder = new BoxStoreBuilder(model).directory(boxStoreDir);
         builder.entity(new TestEntity_());
-        builder.validateOnOpen(ValidateOnOpenMode.Full);
+        builder.validateOnOpen(ValidateOnOpenModePages.Full);
         store = builder.build();
         assertNotNull(getTestEntityBox().get(id));
         getTestEntityBox().put(new TestEntity(0));
@@ -75,7 +75,7 @@ public void validateOnOpenCorruptFile() throws IOException {
         prepareBadDataFile(dir, "corrupt-pageno-in-branch-data.mdb");
 
         builder = BoxStoreBuilder.createDebugWithoutModel().directory(dir);
-        builder.validateOnOpen(ValidateOnOpenMode.Full);
+        builder.validateOnOpen(ValidateOnOpenModePages.Full);
 
         @SuppressWarnings("resource")
         FileCorruptException ex = assertThrows(PagesCorruptException.class, () -> builder.build());
@@ -90,7 +90,7 @@ public void usePreviousCommitWithCorruptFile() throws IOException {
         File dir = prepareTempDir("object-store-test-corrupted");
         prepareBadDataFile(dir, "corrupt-pageno-in-branch-data.mdb");
         builder = BoxStoreBuilder.createDebugWithoutModel().directory(dir);
-        builder.validateOnOpen(ValidateOnOpenMode.Full).usePreviousCommit();
+        builder.validateOnOpen(ValidateOnOpenModePages.Full).usePreviousCommit();
         store = builder.build();
         String diagnoseString = store.diagnose();
         assertTrue(diagnoseString.contains("entries=2"));
@@ -104,7 +104,7 @@ public void usePreviousCommitAfterFileCorruptException() throws IOException {
         File dir = prepareTempDir("object-store-test-corrupted");
         prepareBadDataFile(dir, "corrupt-pageno-in-branch-data.mdb");
         builder = BoxStoreBuilder.createDebugWithoutModel().directory(dir);
-        builder.validateOnOpen(ValidateOnOpenMode.Full);
+        builder.validateOnOpen(ValidateOnOpenModePages.Full);
         try {
             store = builder.build();
             fail("Should have thrown");