Record Class ScanResult

java.lang.Object
java.lang.Record
com.loomcache.common.protocol.ScanResult
Record Components:
cursor - the position for the next scan (0 = scan is complete)
keys - the list of keys matched in this scan iteration
public record ScanResult(long cursor, List<String> keys) extends Record
Result of a cursor-based scan operation on a data structure (Map, Set).

Implements Redis-like cursor iteration:

  • cursor = 0 on input means start from beginning
  • cursor in result = position to continue from next scan, or 0 if done
  • keys = list of matched keys (up to count limit)

Thread-safe: immutable record with no mutable state.

Since:
1.2

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScanResult(long cursor, List<String> keys)
    Creates an instance of a ScanResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    cursor()
    Returns the value of the cursor record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isComplete()
    Returns true if the scan is complete (cursor is 0).
    List<String>
    keys()
    Returns the value of the keys record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • ScanResult

      public ScanResult(long cursor, List<String> keys)
      Creates an instance of a ScanResult record class.
      Parameters:
      cursor - the value for the cursor record component
      keys - the value for the keys record component

  • Method Details

    • isComplete

      public boolean isComplete()
      Returns true if the scan is complete (cursor is 0).

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • cursor

      public long cursor()
      Returns the value of the cursor record component.
      Returns:
      the value of the cursor record component

    • keys

      public List<String> keys()
      Returns the value of the keys record component.
      Returns:
      the value of the keys record component