Package io.ably.lib.liveobjects.message

Interface ObjectsMapEntry

public interface ObjectsMapEntry

Represents the value at a given key in a LiveMap object.

Spec: OME1

Method Summary

Modifier and Type	Method	Description
@Nullable ObjectData	getData()	Returns the data that represents the value of the map entry.
@Nullable Long	getSerialTimestamp()	Returns the timestamp derived from the timeserial of this entry, as milliseconds since the epoch.
@Nullable String	getTimeserial()	Returns the serial value of the latest operation that was applied to the map entry.
@Nullable Boolean	getTombstone()	Indicates whether the map entry has been removed.

Method Details

getTombstone

@Nullable
@Nullable Boolean getTombstone()

Indicates whether the map entry has been removed.

Spec: OME2a

Returns:

true if the entry is tombstoned, or null if unavailable

getTimeserial

@Nullable
@Nullable String getTimeserial()

Returns the serial value of the latest operation that was applied to the map entry.

Spec: OME2b

Returns:

the entry timeserial, or null if unavailable

getSerialTimestamp

@Nullable
@Nullable Long getSerialTimestamp()

Returns the timestamp derived from the timeserial of this entry, as milliseconds since the epoch. Only present if getTombstone() is true.

Spec: OME2d

Returns:

the serial timestamp in milliseconds since the epoch, or null if unavailable

getData

@Nullable
@Nullable ObjectData getData()

Returns the data that represents the value of the map entry.

Spec: OME2c

Returns:

the entry value, or null if unavailable