Package redis.clients.jedis.params

Class ScanParams

  • public class ScanParams
extends java.lang.Object
    Parameters for SCAN command in Jedis compatibility layer.

    • Constructor Summary

      Constructors 
      Constructor Description
      ScanParams()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ScanParams count​(int count)
      Set the COUNT hint for the scan.
      java.lang.Long getCount()
      Get the count hint.
      java.lang.String getMatchPattern()
      Get the match pattern.
      java.lang.String getType()
      Get the type filter.
      ScanParams match​(byte[] pattern)
      Set the MATCH pattern for the scan.
      ScanParams match​(java.lang.String pattern)
      Set the MATCH pattern for the scan.
      ScanParams type​(java.lang.String type)
      Set the TYPE filter for the scan.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • SCAN_POINTER_START

        public static final java.lang.String SCAN_POINTER_START
        See Also:
        Constant Field Values

      • SCAN_POINTER_START_BINARY

        public static final byte[] SCAN_POINTER_START_BINARY

    • Constructor Detail

      • ScanParams

        public ScanParams()

    • Method Detail

      • match

        public ScanParams match​(java.lang.String pattern)
        Set the MATCH pattern for the scan.
        Parameters:
        pattern - the pattern to match
        Returns:
        this ScanParams instance

      • match

        public ScanParams match​(byte[] pattern)
        Set the MATCH pattern for the scan.
        Parameters:
        pattern - the pattern to match
        Returns:
        this ScanParams instance

      • count

        public ScanParams count​(int count)
        Set the COUNT hint for the scan.
        Parameters:
        count - the count hint
        Returns:
        this ScanParams instance

      • type

        public ScanParams type​(java.lang.String type)
        Set the TYPE filter for the scan.
        Parameters:
        type - the type to filter by
        Returns:
        this ScanParams instance

      • getMatchPattern

        public java.lang.String getMatchPattern()
        Get the match pattern.
        Returns:
        the match pattern

      • getCount

        public java.lang.Long getCount()
        Get the count hint.
        Returns:
        the count hint

      • getType

        public java.lang.String getType()
        Get the type filter.
        Returns:
        the type filter