SyncClient: change some "request" methods to return a bool

Author: greenrobot

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

@@ -1,6 +1,7 @@
 package io.objectbox.sync;
 
 import io.objectbox.annotation.apihint.Experimental;
+import io.objectbox.annotation.apihint.Temporary;
 import io.objectbox.sync.SyncBuilder.RequestUpdatesMode;
 import io.objectbox.sync.listener.SyncChangeListener;
 import io.objectbox.sync.listener.SyncCompletedListener;
@@ -116,30 +117,38 @@ public interface SyncClient extends Closeable {
      * {@link SyncBuilder#requestUpdatesMode(RequestUpdatesMode) requestUpdatesMode(MANUAL)}.
      *
      * @see #cancelUpdates()
+     * @return 'true' if the request was likely sent (e.g. the sync client is in "logged in" state)
+     * or 'false' if the request was not sent (and will not be sent in the future)
      */
-    void requestUpdates();
+    boolean requestUpdates();
 
     /**
      * Asks the server to send sync updates until this sync client is up-to-date, then pauses sync updates again.
      * This is useful if sync updates were turned off with
      * {@link SyncBuilder#requestUpdatesMode(RequestUpdatesMode) requestUpdatesMode(MANUAL)}.
+     * @return 'true' if the request was likely sent (e.g. the sync client is in "logged in" state)
+     * or 'false' if the request was not sent (and will not be sent in the future)
      */
-    void requestUpdatesOnce();
+    boolean requestUpdatesOnce();
 
     /**
      * Asks the server to pause sync updates.
      *
+     * @return 'true' if the request was likely sent (e.g. the sync client is in "logged in" state)
+     * or 'false' if the request was not sent (and will not be sent in the future)
      * @see #requestUpdates()
      */
-    void cancelUpdates();
+    boolean cancelUpdates();
 
     /**
      * Experimental. This API might change or be removed in the future.
      * <p>
      * Request a sync of all previous changes from the server.
+     * @return 'true' if the request was likely sent (e.g. the sync client is in "logged in" state)
+     * or 'false' if the request was not sent (and will not be sent in the future)
      */
-    @Experimental
-    void requestFullSync();
+    @Temporary
+    boolean requestFullSync();
 
     /**
      * Lets the sync client know that a working network connection

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

@@ -2,8 +2,8 @@
 
 import io.objectbox.BoxStore;
 import io.objectbox.InternalAccess;
-import io.objectbox.annotation.apihint.Experimental;
 import io.objectbox.annotation.apihint.Internal;
+import io.objectbox.annotation.apihint.Temporary;
 import io.objectbox.sync.SyncBuilder.RequestUpdatesMode;
 import io.objectbox.sync.listener.SyncChangeListener;
 import io.objectbox.sync.listener.SyncCompletedListener;
@@ -210,29 +210,30 @@ protected void finalize() throws Throwable {
     }
 
     @Override
-    public void requestFullSync() {
-        nativeRequestFullSync(handle, false);
+    @Temporary
+    public boolean requestFullSync() {
+        return nativeRequestFullSync(handle, false);
     }
 
     // TODO: broken?
-    @Experimental
-    public void requestFullSyncAndUpdates() {
-        nativeRequestFullSync(handle, true);
+    @Temporary
+    public boolean requestFullSyncAndUpdates() {
+        return nativeRequestFullSync(handle, true);
     }
 
     @Override
-    public void requestUpdates() {
-        nativeRequestUpdates(handle, true);
+    public boolean requestUpdates() {
+        return nativeRequestUpdates(handle, true);
     }
 
     @Override
-    public void requestUpdatesOnce() {
-        nativeRequestUpdates(handle, false);
+    public boolean requestUpdatesOnce() {
+        return nativeRequestUpdates(handle, false);
     }
 
     @Override
-    public void cancelUpdates() {
-        nativeCancelUpdates(handle);
+    public boolean cancelUpdates() {
+        return nativeCancelUpdates(handle);
     }
 
     @Override
@@ -272,13 +273,13 @@ public void notifyConnectionAvailable() {
     private native int nativeGetState(long handle);
 
     /** @param subscribeForPushes Pass true to automatically receive updates for future changes. */
-    private native void nativeRequestUpdates(long handle, boolean subscribeForPushes);
+    private native boolean nativeRequestUpdates(long handle, boolean subscribeForPushes);
 
     /** @param subscribeForPushes Pass true to automatically receive updates for future changes. */
-    private native void nativeRequestFullSync(long handle, boolean subscribeForPushes);
+    private native boolean nativeRequestFullSync(long handle, boolean subscribeForPushes);
 
     /** (Optional) Pause sync updates. */
-    private native void nativeCancelUpdates(long handle);
+    private native boolean nativeCancelUpdates(long handle);
 
     /**
      *  Hints to the native client that an active network connection is available.

tests/objectbox-java-test/src/test/java/io/objectbox/sync/ConnectivityMonitorTest.java

@@ -159,23 +159,23 @@ public void close() {
         }
 
         @Override
-        public void requestUpdates() {
-
+        public boolean requestUpdates() {
+            return false;
         }
 
         @Override
-        public void requestUpdatesOnce() {
-
+        public boolean requestUpdatesOnce() {
+            return false;
         }
 
         @Override
-        public void cancelUpdates() {
-
+        public boolean cancelUpdates() {
+            return false;
         }
 
         @Override
-        public void requestFullSync() {
-
+        public boolean requestFullSync() {
+            return false;
         }
 
         @Override