Package io.deephaven.kv

Class WatchResponseUnit

java.lang.Object

io.deephaven.kv.WatchResponseUnit

public final class WatchResponseUnit
extends Object

An immutable unit response derived from a WatchResponse. Presents a simpler data model that listeners can consume without needing to deal with the boundaries between modification revisions in a WatchResponse.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
HeaderResponse	getHeader()	The watch response header.
long	getModificationRevision()	Guaranteed to be less-than-or-equal-to getHeader().getRevision().
KeyValuesCollection	getRemoved()	Get the collection of Keys and values that have been removed in this unit.
KeyValuesCollection	getUpdated()	Get the collection of Keys and values that have been updated or added in this unit.
int	hashCode()
boolean	isLastUnit()	A unit is the last unit if getModificationRevision() is equal to the largest modification revision in the WatchResponse.
static @NotNull List<WatchResponseUnit>	parse(@NotNull WatchResponse response)	Converts a watch response into a list of watch response units.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

parse

@NotNull
public static @NotNull List<WatchResponseUnit> parse(@NotNull
 @NotNull WatchResponse response)

Converts a watch response into a list of watch response units.

The list will be ordered by getModificationRevision().

Parameters:

response - the watch response

Returns:

the list of watch response units

getHeader

public HeaderResponse getHeader()

The watch response header.

Returns:

the header

getUpdated

public KeyValuesCollection getUpdated()

Get the collection of Keys and values that have been updated or added in this unit. All key values will have their mod rev equal to getModificationRevision().

There will be no overlapping keys with respect to getRemoved().

There will be at least one item between getRemoved() and the returned values.

Returns:

the updated key values

getRemoved

public KeyValuesCollection getRemoved()

Get the collection of Keys and values that have been removed in this unit. All key values will have their mod rev equal to getModificationRevision().

There will be no overlapping keys with respect to getUpdated().

There will be at least one item between getUpdated() and the returned values.

Returns:

the removed key values

getModificationRevision

public long getModificationRevision()

Guaranteed to be less-than-or-equal-to getHeader().getRevision().

Returns:

the modification revision

isLastUnit

public boolean isLastUnit()

A unit is the last unit if getModificationRevision() is equal to the largest modification revision in the WatchResponse.

Returns:

true iff this unit is the last unit in the WatchResponse

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object