Created and configured liveobjects as a separate module to the project

1. Declared required liveobject java interfaces
2. Implemented liveobject interface for LiveObjectsPlugin

Author: ttypic

android/src/main/java/io/ably/lib/realtime/Channel.java

@@ -3,6 +3,8 @@
 import io.ably.lib.types.AblyException;
 import io.ably.lib.types.ChannelOptions;
 import io.ably.lib.push.PushChannel;
+import io.ably.lib.objects.LiveObjectsPlugin;
+
 
 public class Channel extends ChannelBase {
     /**
@@ -12,8 +14,8 @@ public class Channel extends ChannelBase {
      */
     public final PushChannel push;
 
-    Channel(AblyRealtime ably, String name, ChannelOptions options) throws AblyException {
-        super(ably, name, options);
+    Channel(AblyRealtime ably, String name, ChannelOptions options, LiveObjectsPlugin liveObjectsPlugin) throws AblyException {
+        super(ably, name, options, liveObjectsPlugin);
         this.push = ((io.ably.lib.rest.AblyRest) ably).channels.get(name, options).push;
     }
 

java/src/main/java/io/ably/lib/realtime/Channel.java

@@ -1,11 +1,12 @@
 package io.ably.lib.realtime;
 
+import io.ably.lib.objects.LiveObjectsPlugin;
 import io.ably.lib.types.AblyException;
 import io.ably.lib.types.ChannelOptions;
 
 public class Channel extends ChannelBase {
-    Channel(AblyRealtime ably, String name, ChannelOptions options) throws AblyException {
-        super(ably, name, options);
+    Channel(AblyRealtime ably, String name, ChannelOptions options, LiveObjectsPlugin liveObjectsPlugin) throws AblyException {
+        super(ably, name, options, liveObjectsPlugin);
     }
 
     public interface MessageListener extends ChannelBase.MessageListener {}

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

@@ -0,0 +1,42 @@
+package io.ably.lib.objects;
+
+import io.ably.lib.types.Callback;
+
+/**
+ * The LiveCounter interface provides methods to interact with a live counter.
+ * It allows incrementing, decrementing, and retrieving the current value of the counter,
+ * both synchronously and asynchronously.
+ */
+public interface LiveCounter {
+
+    /**
+     * Increments the value of the counter by 1.
+     */
+    void increment();
+
+    /**
+     * Increments the value of the counter by 1 asynchronously.
+     *
+     * @param callback the callback to be invoked upon completion of the operation.
+     */
+    void incrementAsync(Callback<Void> callback);
+
+    /**
+     * Decrements the value of the counter by 1.
+     */
+    void decrement();
+
+    /**
+     * Decrements the value of the counter by 1 asynchronously.
+     *
+     * @param callback the callback to be invoked upon completion of the operation.
+     */
+    void decrementAsync(Callback<Void> callback);
+
+    /**
+     * Retrieves the current value of the counter.
+     *
+     * @return the current value of the counter as a Long.
+     */
+    Long value();
+}

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

@@ -0,0 +1,82 @@
+package io.ably.lib.objects;
+
+import io.ably.lib.types.Callback;
+
+import java.util.Map;
+
+/**
+ * The LiveMap interface provides methods to interact with a live, real-time map structure.
+ * It supports both synchronous and asynchronous operations for managing key-value pairs.
+ */
+public interface LiveMap {
+
+    /**
+     * Retrieves the value associated with the specified key.
+     *
+     * @param keyName the key whose associated value is to be returned.
+     * @return the value associated with the specified key, or null if the key does not exist.
+     */
+    Object get(String keyName);
+
+    /**
+     * Retrieves all entries (key-value pairs) in the map.
+     *
+     * @return an iterable collection of all entries in the map.
+     */
+    Iterable<Map.Entry<String, Object>> entries();
+
+    /**
+     * Retrieves all keys in the map.
+     *
+     * @return an iterable collection of all keys in the map.
+     */
+    Iterable<String> keys();
+
+    /**
+     * Retrieves all values in the map.
+     *
+     * @return an iterable collection of all values in the map.
+     */
+    Iterable<Object> values();
+
+    /**
+     * Sets the specified key to the given value in the map.
+     *
+     * @param keyName the key to be set.
+     * @param value the value to be associated with the key.
+     */
+    void set(String keyName, Object value);
+
+    /**
+     * Removes the specified key and its associated value from the map.
+     *
+     * @param keyName the key to be removed.
+     * @param value the value associated with the key to be removed.
+     */
+    void remove(String keyName, Object value);
+
+    /**
+     * Retrieves the number of entries in the map.
+     *
+     * @return the size of the map.
+     */
+    Long size();
+
+    /**
+     * Asynchronously sets the specified key to the given value in the map.
+     *
+     * @param keyName the key to be set.
+     * @param value the value to be associated with the key.
+     * @param callback the callback to handle the result or any errors.
+     */
+    void setAsync(String keyName, Object value, Callback<Void> callback);
+
+    /**
+     * Asynchronously removes the specified key and its associated value from the map.
+     *
+     * @param keyName the key to be removed.
+     * @param value the value associated with the key to be removed.
+     * @param callback the callback to handle the result or any errors.
+     */
+    void removeAsync(String keyName, Object value, Callback<Void> callback);
+}

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

@@ -0,0 +1,99 @@
+package io.ably.lib.objects;
+
+import io.ably.lib.objects.batch.BatchContext;
+import io.ably.lib.types.Callback;
+
+import java.util.Map;
+
+/**
+ * The LiveObjects interface provides methods to interact with live data objects,
+ * such as maps and counters, in a real-time environment. It supports both synchronous
+ * and asynchronous operations for retrieving and creating live objects.
+ */
+public interface LiveObjects {
+
+    /**
+     * Retrieves the root LiveMap object.
+     *
+     * @return the root LiveMap instance.
+     */
+    LiveMap getRoot();
+
+    /**
+     * Initiates a batch operation and provides a BatchContext through a callback.
+     *
+     * @param batchContextCallback the callback to handle the BatchContext or error.
+     */
+    void batch(Callback<BatchContext> batchContextCallback);
+
+    /**
+     * Creates a new LiveMap based on an existing LiveMap.
+     *
+     * @param liveMap the existing LiveMap to base the new LiveMap on.
+     * @return the newly created LiveMap instance.
+     */
+    LiveMap createMap(LiveMap liveMap);
+
+    /**
+     * Creates a new LiveMap based on a LiveCounter.
+     *
+     * @param liveCounter the LiveCounter to base the new LiveMap on.
+     * @return the newly created LiveMap instance.
+     */
+    LiveMap createMap(LiveCounter liveCounter);
+
+    /**
+     * Creates a new LiveMap based on a standard Java Map.
+     *
+     * @param map the Java Map to base the new LiveMap on.
+     * @return the newly created LiveMap instance.
+     */
+    LiveMap createMap(Map<String, Object> map);
+
+    /**
+     * Creates a new LiveCounter with an initial value.
+     *
+     * @param initialValue the initial value of the LiveCounter.
+     * @return the newly created LiveCounter instance.
+     */
+    LiveCounter createCounter(Long initialValue);
+
+    /**
+     * Asynchronously retrieves the root LiveMap object.
+     *
+     * @param callback the callback to handle the result or error.
+     */
+    void getRootAsync(Callback<LiveMap> callback);
+
+    /**
+     * Asynchronously creates a new LiveMap based on an existing LiveMap.
+     *
+     * @param liveMap the existing LiveMap to base the new LiveMap on.
+     * @param callback the callback to handle the result or error.
+     */
+    void createMapAsync(LiveMap liveMap, Callback<LiveMap> callback);
+
+    /**
+     * Asynchronously creates a new LiveMap based on a LiveCounter.
+     *
+     * @param liveCounter the LiveCounter to base the new LiveMap on.
+     * @param callback the callback to handle the result or error.
+     */
+    void createMapAsync(LiveCounter liveCounter, Callback<LiveMap> callback);
+
+    /**
+     * Asynchronously creates a new LiveMap based on a standard Java Map.
+     *
+     * @param map the Java Map to base the new LiveMap on.
+     * @param callback the callback to handle the result or error.
+     */
+    void createMapAsync(Map<String, Object> map, Callback<LiveMap> callback);
+
+    /**
+     * Asynchronously creates a new LiveCounter with an initial value.
+     *
+     * @param initialValue the initial value of the LiveCounter.
+     * @param callback the callback to handle the result or error.
+     */
+    void createCounterAsync(Long initialValue, Callback<LiveCounter> callback);
+}

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

@@ -0,0 +1,25 @@
+package io.ably.lib.objects;
+
+/**
+ * The LiveObjectsPlugin interface provides a mechanism to retrieve instances of LiveObjects
+ * associated with specific channel names. This allows for interaction with live data objects
+ * in a real-time environment.
+ */
+public interface LiveObjectsPlugin {
+
+    /**
+     * Retrieves an instance of LiveObjects associated with the specified channel name.
+     *
+     * @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.
+     */
+    LiveObjects getInstance(String channelName);
+
+
+    /**
+     * Disposes of the LiveObjects instance associated with the specified channel name.
+     *
+     * @param channelName the name of the channel whose LiveObjects instance is to be removed.
+     */
+    void dispose(String channelName);
+}

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

@@ -0,0 +1,17 @@
+package io.ably.lib.objects.batch;
+
+
+/**
+ * The BatchContext interface represents the context for batch operations
+ * on live data objects. It provides access to the root LiveMap, which serves
+ * as the entry point for interacting with the batch context.
+ */
+public interface BatchContext {
+
+    /**
+     * Retrieves the root LiveMap associated with this batch context.
+     *
+     * @return the root LiveMap instance.
+     */
+    BatchContextLiveMap getRoot();
+}

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

@@ -0,0 +1,63 @@
+package io.ably.lib.objects.batch;
+
+import java.util.Map;
+
+/**
+ * The BatchContextLiveMap interface provides methods to interact with a live map
+ * in the context of batch operations. It allows retrieving, modifying, and querying
+ * key-value pairs in the map.
+ */
+public interface BatchContextLiveMap {
+
+    /**
+     * Retrieves the value associated with the specified key.
+     *
+     * @param keyName the name of the key whose value is to be retrieved.
+     * @return the value associated with the specified key, or null if the key does not exist.
+     */
+    Object get(String keyName);
+
+    /**
+     * Retrieves all entries (key-value pairs) in the live map.
+     *
+     * @return an iterable collection of map entries.
+     */
+    Iterable<Map.Entry<String, Object>> entries();
+
+    /**
+     * Retrieves all keys in the live map.
+     *
+     * @return an iterable collection of keys.
+     */
+    Iterable<String> keys();
+
+    /**
+     * Retrieves all values in the live map.
+     *
+     * @return an iterable collection of values.
+     */
+    Iterable<Object> values();
+
+    /**
+     * Sets the specified key to the given value in the live map.
+     *
+     * @param keyName the name of the key to set.
+     * @param value the value to associate with the specified key.
+     */
+    void set(String keyName, Object value);
+
+    /**
+     * Removes the specified key-value pair from the live map.
+     *
+     * @param keyName the name of the key to remove.
+     * @param value the value associated with the key to remove.
+     */
+    void remove(String keyName, Object value);
+
+    /**
+     * Retrieves the number of entries in the live map.
+     *
+     * @return the size of the live map as a Long.
+     */
+    Long size();
+}