Class PendingMessages

java.lang.Object
org.springframework.data.redis.connection.stream.PendingMessages
All Implemented Interfaces:
Iterable<PendingMessage>, Supplier<Stream<PendingMessage>>, org.springframework.data.util.Streamable<PendingMessage>

public class PendingMessages extends Object implements org.springframework.data.util.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 Details

    • PendingMessages

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

      public PendingMessages(String groupName, org.springframework.data.domain.Range<?> range, List<PendingMessage> pendingMessages)
  • Method Details

    • withinRange

      public PendingMessages withinRange(org.springframework.data.domain.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 org.springframework.data.domain.Range<?> getRange()
      The Range pending messages have been loaded.
      Returns:
      never null.
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.springframework.data.util.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