Class ReactiveStreamCommands.ReadCommand

java.lang.Object

org.springframework.data.redis.connection.ReactiveStreamCommands.ReadCommand

Enclosing interface:

ReactiveStreamCommands

public static class ReactiveStreamCommands.ReadCommand
extends Object

XRANGE/XREVRANGE command parameters.

Since:

2.2

Author:

Mark Paluch, Christoph Strobl, Tugdual Grall, Dengliming, Mark John Moreno, jinkshower, Jeonggyu Choi

See Also:

• Redis Documentation: XRANGE
• Redis Documentation: XREVRANGE

Constructor Summary

Constructors

Constructor	Description
ReadCommand(List<StreamOffset<ByteBuffer>> streamOffsets, @Nullable StreamReadOptions readOptions, @Nullable Consumer consumer)

Method Summary

Modifier and Type	Method	Description
ReactiveStreamCommands.ReadCommand	as(Consumer consumer)	Applies a Consumer.
static ReactiveStreamCommands.ReadCommand	from(StreamOffset<ByteBuffer> streamOffset)	Creates a new ReactiveStreamCommands.ReadCommand given a StreamOffset.
static ReactiveStreamCommands.ReadCommand	from(StreamOffset<ByteBuffer>... streamOffsets)	Creates a new ReactiveStreamCommands.ReadCommand given a StreamOffsets.
@Nullable Consumer	getConsumer()
@Nullable StreamReadOptions	getReadOptions()
List<StreamOffset<ByteBuffer>>	getStreamOffsets()
ReactiveStreamCommands.ReadCommand	withOptions(StreamReadOptions options)	Applies the given StreamReadOptions.

Methods inherited from class java.lang.Object

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

Constructor Details

ReadCommand

public ReadCommand(List<StreamOffset<ByteBuffer>> streamOffsets,
 @Nullable StreamReadOptions readOptions,
 @Nullable Consumer consumer)

Parameters:

streamOffsets - must not be null.

readOptions -

consumer -

Method Details

from

public static ReactiveStreamCommands.ReadCommand from(StreamOffset<ByteBuffer> streamOffset)

Creates a new ReactiveStreamCommands.ReadCommand given a StreamOffset.

Parameters:

streamOffset - must not be null.

Returns:

a new ReactiveStreamCommands.ReadCommand for StreamOffset.

from

public static ReactiveStreamCommands.ReadCommand from(StreamOffset<ByteBuffer>... streamOffsets)

Creates a new ReactiveStreamCommands.ReadCommand given a StreamOffsets.

Parameters:

streamOffsets - must not be null.

Returns:

a new ReactiveStreamCommands.ReadCommand for StreamOffsets.

as

public ReactiveStreamCommands.ReadCommand as(Consumer consumer)

Applies a Consumer. Constructs a new command instance with all previously configured properties.

Parameters:

consumer - must not be null.

Returns:

a new ReactiveStreamCommands.ReadCommand with Consumer applied.

withOptions

public ReactiveStreamCommands.ReadCommand withOptions(StreamReadOptions options)

Applies the given StreamReadOptions. Constructs a new command instance with all previously configured properties.

Parameters:

options - must not be null.

Returns:

a new ReactiveStreamCommands.ReadCommand with Consumer applied.

getStreamOffsets

public List<StreamOffset<ByteBuffer>> getStreamOffsets()

getReadOptions

public @Nullable StreamReadOptions getReadOptions()

getConsumer

public @Nullable Consumer getConsumer()