Improve messages if Sync is unavailable etc.

Author: greenrobot

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

@@ -5,15 +5,15 @@
 import io.objectbox.sync.server.SyncServerBuilder;
 
 /**
+ * <a href="https://objectbox.io/sync/">ObjectBox Sync</a> makes data available on other devices.
  * Start building a sync client using Sync.{@link #client(BoxStore, String, SyncCredentials)}
- * or a server using Sync.{@link #server(BoxStore, String, SyncCredentials)}.
+ * or an embedded server using Sync.{@link #server(BoxStore, String, SyncCredentials)}.
  */
 @SuppressWarnings({"unused", "WeakerAccess"})
-@Experimental
 public final class Sync {
 
     /**
-     * Returns true if the included native (JNI) ObjectBox library supports sync.
+     * Returns true if the included native (JNI) ObjectBox library supports Sync.
      */
     public static boolean isAvailable() {
         return BoxStore.isSyncAvailable();

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

@@ -72,7 +72,8 @@ public SyncBuilder(BoxStore boxStore, String url, SyncCredentials credentials) {
         checkNotNull(credentials, "Sync credentials are required.");
         if (!BoxStore.isSyncAvailable()) {
             throw new IllegalStateException(
-                    "This ObjectBox library (JNI) does not include sync. Please update your dependencies.");
+                    "This library does not include ObjectBox Sync. " +
+                            "Please visit https://objectbox.io/sync/ for options.");
         }
         this.platform = Platform.findPlatform();
         this.boxStore = boxStore;

objectbox-java/src/main/java/io/objectbox/sync/server/SyncServerBuilder.java

@@ -30,7 +30,8 @@ public SyncServerBuilder(BoxStore boxStore, String url, SyncCredentials authenti
         checkNotNull(authenticatorCredentials, "Authenticator credentials are required.");
         if (!BoxStore.isSyncServerAvailable()) {
             throw new IllegalStateException(
-                    "This ObjectBox library (JNI) does not include sync server. Check your dependencies.");
+                    "This library does not include ObjectBox Sync Server. " +
+                            "Please visit https://objectbox.io/sync/ for options.");
         }
         this.boxStore = boxStore;
         this.url = url;

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

@@ -6,15 +6,15 @@
 import io.objectbox.BoxStore;
 
 
-import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertThrows;
+import static org.junit.Assert.assertTrue;
 
 public class SyncTest extends AbstractObjectBoxTest {
 
     /**
      * Ensure that non-sync native library correctly reports sync client availability.
-     *
+     * <p>
      * Note: this test is mirrored in objectbox-integration-test sync tests, where sync is available.
      */
     @Test
@@ -24,7 +24,7 @@ public void clientIsNotAvailable() {
 
     /**
      * Ensure that non-sync native library correctly reports sync server availability.
-     *
+     * <p>
      * Note: this test is mirrored in objectbox-integration-test sync tests, where sync is available.
      */
     @Test
@@ -38,6 +38,19 @@ public void creatingSyncClient_throws() {
                 IllegalStateException.class,
                 () -> Sync.client(store, "wss://127.0.0.1", SyncCredentials.none())
         );
-        assertEquals("This ObjectBox library (JNI) does not include sync. Please update your dependencies.", exception.getMessage());
+        String message = exception.getMessage();
+        assertTrue(message, message.contains("does not include ObjectBox Sync") &&
+                message.contains("https://objectbox.io/sync") && !message.contains("erver"));
+    }
+
+    @Test
+    public void creatingSyncServer_throws() {
+        IllegalStateException exception = assertThrows(
+                IllegalStateException.class,
+                () -> Sync.server(store, "wss://127.0.0.1", SyncCredentials.none())
+        );
+        String message = exception.getMessage();
+        assertTrue(message, message.contains("does not include ObjectBox Sync Server") &&
+                message.contains("https://objectbox.io/sync"));
     }
 }