org.springframework.data.redis.connection.stream

Class StreamOffset<K>

java.lang.Object

org.springframework.data.redis.connection.stream.StreamOffset<K>

public final class StreamOffset<K>
extends Object

Value object representing a Stream Id with its offset.

Author:

Mark Paluch

See Also:

2.2

Method Summary

Modifier and Type	Method and Description
static <K> StreamOffset<K>	create(K stream, ReadOffset readOffset) Create a StreamOffset given key and ReadOffset.
boolean	equals(Object o)
static <K> StreamOffset<K>	from(Record<K,?> reference) Create a StreamOffset from the given record id as reference to create the ReadOffset.from(String).
static <K> StreamOffset<K>	fromStart(K stream) Create a StreamOffset given stream starting at ReadOffset#from("0-0").
K	getKey()
ReadOffset	getOffset()
int	hashCode()
static <K> StreamOffset<K>	latest(K stream) Create a StreamOffset given key starting at ReadOffset.latest().
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <K> StreamOffset<K> create(K stream,
                                         ReadOffset readOffset)

Create a StreamOffset given key and ReadOffset.

Parameters:

stream - the stream key.

readOffset - the ReadOffset to use.

Returns:

new instance of StreamOffset.

latest

public static <K> StreamOffset<K> latest(K stream)

Create a StreamOffset given key starting at ReadOffset.latest().

Type Parameters:

K -

Parameters:

stream - the stream key.

Returns:

new instance of StreamOffset.

fromStart

public static <K> StreamOffset<K> fromStart(K stream)

Create a StreamOffset given stream starting at ReadOffset#from("0-0").

Type Parameters:

K -

Parameters:

stream - the stream key.

Returns:

new instance of StreamOffset.

from

public static <K> StreamOffset<K> from(Record<K,?> reference)

Create a StreamOffset from the given record id as reference to create the ReadOffset.from(String).

Type Parameters:

K -

Parameters:

reference - the record to be used as reference point.

Returns:

new instance of StreamOffset.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getKey

public K getKey()

getOffset

public ReadOffset getOffset()