Package io.ably.lib.objects.type.map

Class LiveMapUpdate

java.lang.Object

io.ably.lib.objects.type.ObjectUpdate

io.ably.lib.objects.type.map.LiveMapUpdate

public class LiveMapUpdate
extends ObjectUpdate

Represents an update that occurred on a LiveMap object. Contains information about which keys were modified and whether they were updated or removed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LiveMapUpdate.Change	Indicates the type of change that occurred to a map key.

Field Summary

Fields inherited from class io.ably.lib.objects.type.ObjectUpdate

update

Constructor Summary

Constructors

Constructor	Description
LiveMapUpdate()	Creates a no-op LiveMapUpdate representing no actual change.
LiveMapUpdate(@NotNull Map<String,LiveMapUpdate.Change> update)	Creates a LiveMapUpdate with the specified key changes.

Method Summary

Modifier and Type	Method	Description
@NotNull Map<String,LiveMapUpdate.Change>	getUpdate()	Gets the map of key changes that occurred in this update.
String	toString()	Returns a string representation of this LiveMapUpdate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

LiveMapUpdate

public LiveMapUpdate()

Creates a no-op LiveMapUpdate representing no actual change.

LiveMapUpdate

public LiveMapUpdate(@NotNull
 @NotNull Map<String,LiveMapUpdate.Change> update)

Creates a LiveMapUpdate with the specified key changes.

Parameters:

update - map of key names to their change types (UPDATED or REMOVED)

Method Details

getUpdate

@NotNull
public @NotNull Map<String,LiveMapUpdate.Change> getUpdate()

Gets the map of key changes that occurred in this update.

Returns:

map of key names to their change types

toString

public String toString()

Returns a string representation of this LiveMapUpdate.

Overrides:

toString in class Object

Returns:

a string showing the map key changes in this update