SyncClient: support adding filter variables in builder #280

Author: greenrobot-team

objectbox-java/src/main/java/io/objectbox/sync/SyncBuilder.java

@@ -19,6 +19,8 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
+import java.util.TreeMap;
 
 import javax.annotation.Nullable;
 
@@ -57,6 +59,8 @@ public final class SyncBuilder {
     boolean uncommittedAcks;
 
     RequestUpdatesMode requestUpdatesMode = RequestUpdatesMode.AUTO;
+    // To be helpful when debugging, use a TreeMap so variables are eventually passed ordered by name to the native API
+    final Map<String, String> filterVariables = new TreeMap<>();
 
     public enum RequestUpdatesMode {
         /**
@@ -137,6 +141,22 @@ String serverUrl() {
         return url;
     }
 
+    /**
+     * Adds or replaces a <a href="https://sync.objectbox.io/sync-server/sync-filters">Sync filter</a> variable value
+     * for the given name.
+     * <p>
+     * Sync client filter variables can be used in server-side Sync filters to filter out objects that do not match the
+     * filter.
+     *
+     * @see SyncClient#putFilterVariable
+     */
+    public SyncBuilder filterVariable(String name, String value) {
+        checkNotNull(name, "Filter variable name is null.");
+        checkNotNull(value, "Filter variable value is null.");
+        filterVariables.put(name, value);
+        return this;
+    }
+
     /**
      * Configures a custom set of directory or file paths to search for trusted certificates in.
      * The first path that exists will be used.

objectbox-java/src/main/java/io/objectbox/sync/SyncClient.java

@@ -128,7 +128,8 @@ public interface SyncClient extends Closeable {
     void setSyncTimeListener(@Nullable SyncTimeListener timeListener);
 
     /**
-     * Adds or replaces a Sync filter variable value for the given name.
+     * Adds or replaces a <a href="https://sync.objectbox.io/sync-server/sync-filters">Sync filter</a> variable value
+     * for the given name.
      * <p>
      * Eventually, existing values for the same name are replaced.
      * <p>

objectbox-java/src/main/java/io/objectbox/sync/SyncClientImpl.java

@@ -16,6 +16,7 @@
 
 package io.objectbox.sync;
 
+import java.util.Map;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
@@ -71,6 +72,10 @@ public final class SyncClientImpl implements SyncClient {
         }
         this.handle = handle;
 
+        for (Map.Entry<String, String> entry : builder.filterVariables.entrySet()) {
+            putFilterVariable(entry.getKey(), entry.getValue());
+        }
+
         // Only change setting if not default (automatic sync updates and push subscription enabled).
         if (builder.requestUpdatesMode != RequestUpdatesMode.AUTO) {
             boolean autoRequestUpdates = builder.requestUpdatesMode != RequestUpdatesMode.MANUAL;