org.springframework.data.redis.connection.stream

Class PendingMessages

java.lang.Object

org.springframework.data.redis.connection.stream.PendingMessages

All Implemented Interfaces:

Iterable<PendingMessage>, Supplier<Stream<PendingMessage>>, Streamable<PendingMessage>

public class PendingMessages
extends Object
implements Streamable<PendingMessage>

Value object holding detailed information about pending messages in consumer group for a given Range and offset.

Since:

2.3

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
PendingMessages(String groupName, List<PendingMessage> pendingMessages)
PendingMessages(String groupName, Range<?> range, List<PendingMessage> pendingMessages)

Method Summary

Modifier and Type	Method and Description
PendingMessage	get(int index) Get the PendingMessage at the given position.
String	getGroupName() The consumer group name.
Range<?>	getRange() The Range pending messages have been loaded.
boolean	isEmpty()
Iterator<PendingMessage>	iterator()
int	size()
String	toString()
PendingMessages	withinRange(Range<?> range) Adds the range to the current PendingMessages.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.util.Streamable

and, and, and, and, empty, filter, flatMap, get, map, of, of, of, stream, toList, toSet, toStreamable, toStreamable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PendingMessages

public PendingMessages(String groupName,
                       List<PendingMessage> pendingMessages)

PendingMessages

public PendingMessages(String groupName,
                       Range<?> range,
                       List<PendingMessage> pendingMessages)

Method Detail

withinRange

public PendingMessages withinRange(Range<?> range)

Adds the range to the current PendingMessages.

Parameters:

range - must not be null.

Returns:

new instance of PendingMessages.

getGroupName

public String getGroupName()

The consumer group name.

Returns:

never null.

getRange

public Range<?> getRange()

The Range pending messages have been loaded.

Returns:

never null.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Streamable<PendingMessage>

Returns:

true if no messages pending within range.

size

public int size()

Returns:

the number of pending messages in range.

get

public PendingMessage get(int index)

Get the PendingMessage at the given position.

Parameters:

index -

Returns:

the PendingMessage a the given index.

Throws:

IndexOutOfBoundsException - if the index is out of range.

iterator

public Iterator<PendingMessage> iterator()

Specified by:

iterator in interface Iterable<PendingMessage>

toString

public String toString()

Overrides:

toString in class Object