1. Added blocking and non-blocking annotations to sync and async methods

2. Removed liveobject batching operation specific interfaces

Author: sacOO7

lib/src/main/java/io/ably/lib/objects/LiveCounter.java

@@ -1,6 +1,8 @@
 package io.ably.lib.objects;
 
 import io.ably.lib.types.Callback;
+import org.jetbrains.annotations.Blocking;
+import org.jetbrains.annotations.NonBlocking;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Contract;
 
@@ -18,6 +20,7 @@ public interface LiveCounter {
      * the published COUNTER_INC operation is echoed back to the client and applied to the object following the regular
      * operation application procedure.
      */
+    @Blocking
     void increment();
 
     /**
@@ -29,12 +32,14 @@ public interface LiveCounter {
      *
      * @param callback the callback to be invoked upon completion of the operation.
      */
+    @NonBlocking
     void incrementAsync(@NotNull Callback<Void> callback);
 
     /**
      * Decrements the value of the counter by 1.
      * An alias for calling {@link LiveCounter#increment()} with a negative amount.
      */
+    @Blocking
     void decrement();
 
     /**
@@ -43,6 +48,7 @@ public interface LiveCounter {
      *
      * @param callback the callback to be invoked upon completion of the operation.
      */
+    @NonBlocking
     void decrementAsync(@NotNull Callback<Void> callback);
 
     /**

lib/src/main/java/io/ably/lib/objects/LiveMap.java

@@ -1,6 +1,8 @@
 package io.ably.lib.objects;
 
 import io.ably.lib.types.Callback;
+import org.jetbrains.annotations.Blocking;
+import org.jetbrains.annotations.NonBlocking;
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -66,6 +68,7 @@ public interface LiveMap {
      * @param keyName the key to be set.
      * @param value the value to be associated with the key.
      */
+    @Blocking
     void set(@NotNull String keyName, @NotNull Object value);
 
     /**
@@ -77,6 +80,7 @@ public interface LiveMap {
      *
      * @param keyName the key to be removed.
      */
+    @Blocking
     void remove(@NotNull String keyName);
 
     /**
@@ -99,6 +103,7 @@ public interface LiveMap {
      * @param value the value to be associated with the key.
      * @param callback the callback to handle the result or any errors.
      */
+    @NonBlocking
     void setAsync(@NotNull String keyName, @NotNull Object value, @NotNull Callback<Void> callback);
 
     /**
@@ -111,5 +116,6 @@ public interface LiveMap {
      * @param keyName  the key to be removed.
      * @param callback the callback to handle the result or any errors.
      */
+    @NonBlocking
     void removeAsync(@NotNull String keyName, @NotNull Callback<Void> callback);
 }

lib/src/main/java/io/ably/lib/objects/LiveObjects.java

@@ -1,7 +1,8 @@
 package io.ably.lib.objects;
 
-import io.ably.lib.objects.batch.BatchContextBuilder;
 import io.ably.lib.types.Callback;
+import org.jetbrains.annotations.Blocking;
+import org.jetbrains.annotations.NonBlocking;
 import org.jetbrains.annotations.NotNull;
 
 
@@ -25,18 +26,10 @@ public interface LiveObjects {
      *
      * @return the root LiveMap instance.
      */
+    @Blocking
     @NotNull
     LiveMap getRoot();
 
-    /**
-     * Initiates a batch operation and provides a BatchContext through a callback.
-     * Provides access to the synchronous write API for Objects that can be used to batch multiple operations
-     * together in a single channel message.
-     *
-     * @param batchContextCallback the builder to configure the batch operation.
-     */
-    void batch(@NotNull BatchContextBuilder batchContextCallback);
-
     /**
      * Creates a new LiveMap based on an existing LiveMap.
      * Send a MAP_CREATE operation to the realtime system to create a new map object in the pool.
@@ -47,6 +40,7 @@ public interface LiveObjects {
      * @param liveMap the existing LiveMap to base the new LiveMap on.
      * @return the newly created LiveMap instance.
      */
+    @Blocking
     @NotNull
     LiveMap createMap(@NotNull LiveMap liveMap);
 
@@ -60,6 +54,7 @@ public interface LiveObjects {
      * @param liveCounter the LiveCounter to base the new LiveMap on.
      * @return the newly created LiveMap instance.
      */
+    @Blocking
     @NotNull
     LiveMap createMap(@NotNull LiveCounter liveCounter);
 
@@ -73,6 +68,7 @@ public interface LiveObjects {
      * @param map the Java Map to base the new LiveMap on.
      * @return the newly created LiveMap instance.
      */
+    @Blocking
     @NotNull
     LiveMap createMap(@NotNull Map<String, Object> map);
 
@@ -86,6 +82,7 @@ public interface LiveObjects {
      * @param initialValue the initial value of the LiveCounter.
      * @return the newly created LiveCounter instance.
      */
+    @Blocking
     @NotNull
     LiveCounter createCounter(@NotNull Long initialValue);
 
@@ -97,18 +94,9 @@ public interface LiveObjects {
      *
      * @param callback the callback to handle the result or error.
      */
+    @NonBlocking
     void getRootAsync(@NotNull Callback<@NotNull LiveMap> callback);
 
-    /**
-     * Initiates a batch operation asynchronously.
-     * Provides access to the synchronous write API for Objects that can be used to batch multiple operations
-     * together in a single channel message.
-     *
-     * @param batchContextCallback the builder to configure the batch operation.
-     * @param callback the Callback to handle the completion or error of the batch operation.
-     */
-    void batchAsync(@NotNull BatchContextBuilder batchContextCallback, @NotNull Callback<Void> callback);
-
     /**
      * Asynchronously creates a new LiveMap based on an existing LiveMap.
      * Send a MAP_CREATE operation to the realtime system to create a new map object in the pool.
@@ -119,6 +107,7 @@ public interface LiveObjects {
      * @param liveMap the existing LiveMap to base the new LiveMap on.
      * @param callback the callback to handle the result or error.
      */
+    @NonBlocking
     void createMapAsync(@NotNull LiveMap liveMap, @NotNull Callback<@NotNull LiveMap> callback);
 
     /**
@@ -131,6 +120,7 @@ public interface LiveObjects {
      * @param liveCounter the LiveCounter to base the new LiveMap on.
      * @param callback the callback to handle the result or error.
      */
+    @NonBlocking
     void createMapAsync(@NotNull LiveCounter liveCounter, @NotNull Callback<@NotNull LiveMap> callback);
 
     /**
@@ -143,6 +133,7 @@ public interface LiveObjects {
      * @param map the Java Map to base the new LiveMap on.
      * @param callback the callback to handle the result or error.
      */
+    @NonBlocking
     void createMapAsync(@NotNull Map<String, Object> map, @NotNull Callback<@NotNull LiveMap> callback);
 
     /**
@@ -155,5 +146,6 @@ public interface LiveObjects {
      * @param initialValue the initial value of the LiveCounter.
      * @param callback the callback to handle the result or error.
      */
+    @NonBlocking
     void createCounterAsync(@NotNull Long initialValue, @NotNull Callback<@NotNull LiveCounter> callback);
 }

lib/src/main/java/io/ably/lib/objects/LiveObjectsPlugin.java

@@ -18,6 +18,7 @@ public interface LiveObjectsPlugin extends PluginInstance {
      * @param channelName the name of the channel for which the LiveObjects instance is to be retrieved.
      * @return the LiveObjects instance associated with the specified channel name.
      */
+    @NotNull
     LiveObjects getInstance(@NotNull String channelName);
 
     /**

lib/src/main/java/io/ably/lib/objects/batch/BatchContext.java

@@ -192,7 +192,7 @@ private LiveObjectsPlugin tryInitializeLiveObjectsPlugin() {
                 .newInstance(this.connection.connectionManager);
         } catch (ClassNotFoundException | InstantiationException | IllegalAccessException | NoSuchMethodException |
                  InvocationTargetException e) {
-            Log.w(TAG, "LiveObjects plugin not found in classpath. LiveObjects functionality will not be available.", e);
+            Log.i(TAG, "LiveObjects plugin not found in classpath. LiveObjects functionality will not be available.", e);
             return null;
         }
     }

lib/src/main/java/io/ably/lib/objects/batch/BatchContextBuilder.java

@@ -98,7 +98,8 @@ public abstract class ChannelBase extends EventEmitter<ChannelEvent, ChannelStat
     public LiveObjects getObjects() throws AblyException {
         if (liveObjectsPlugin == null) {
             throw AblyException.fromErrorInfo(
-                new ErrorInfo("LiveObjects plugin hasn't been installed, add runtimeOnly('io.ably:live-objects:<ably-version>') to your dependency tree", 400, 40000)
+                new ErrorInfo("LiveObjects plugin hasn't been installed, " +
+                    "add runtimeOnly('io.ably:live-objects:<ably-version>') to your dependency tree", 400, 40019)
             );
         }
         return liveObjectsPlugin.getInstance(name);

lib/src/main/java/io/ably/lib/objects/batch/BatchContextLiveMap.java

@@ -8,10 +8,6 @@ internal class DefaultLiveObjects(private val channelName: String): LiveObjects
     TODO("Not yet implemented")
   }
 
-  override fun batch(batchContextCallback: BatchContextBuilder) {
-    TODO("Not yet implemented")
-  }
-
   override fun createMap(liveMap: LiveMap): LiveMap {
     TODO("Not yet implemented")
   }
@@ -28,10 +24,6 @@ internal class DefaultLiveObjects(private val channelName: String): LiveObjects
     TODO("Not yet implemented")
   }
 
-  override fun batchAsync(batchContextCallback: BatchContextBuilder, callback: Callback<Void>) {
-    TODO("Not yet implemented")
-  }
-
   override fun createMapAsync(liveMap: LiveMap, callback: Callback<LiveMap>) {
     TODO("Not yet implemented")
   }