ArgrepParams (Jedis 8.0.0 API)

java.lang.Object
- redis.clients.jedis.params.ArgrepParams

All Implemented Interfaces:

IParams
```
@Experimental
public class ArgrepParams
extends java.lang.Object
implements IParams
```
Arguments for the ARGREP command. Every instance carries the mandatory start end bounds of the search range; instances are obtained through one of the static factories (unbounded(), range(long, long), from(long), to(long)) and may be flipped with reversed() to traverse in descending index order. Predicates, combinator (AND/OR), LIMIT and NOCASE are appended via fluent setters in the order required by the wire protocol. The WITHVALUES flag is not exposed here: use argrepWithValues to request index/value pairs.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addParams(CommandArguments args)`
`ArgrepParams`	`and()` Combine multiple predicates with logical AND.
`boolean`	`equals(java.lang.Object o)`
`ArgrepParams`	`exact(byte[] value)` Add an `EXACT` predicate: matches elements whose value equals the given bytes exactly.
`ArgrepParams`	`exact(java.lang.String value)` Add an `EXACT` predicate: matches elements whose value equals the given string exactly.
`static ArgrepParams`	`from(long start)` Search from a concrete start index to the end of the array (wire end `+`).
`ArgrepParams`	`glob(byte[] pattern)` Add a `GLOB` predicate: matches elements against a glob-style pattern (supports `*`, `?`
`ArgrepParams`	`glob(java.lang.String pattern)` Add a `GLOB` predicate: matches elements against a glob-style pattern (supports `*`, `?`
`int`	`hashCode()`
`ArgrepParams`	`limit(long limit)` Cap the number of matches returned.
`ArgrepParams`	`match(byte[] value)` Add a `MATCH` predicate: matches elements that contain the given bytes as a substring.
`ArgrepParams`	`match(java.lang.String value)` Add a `MATCH` predicate: matches elements that contain the given string as a substring.
`ArgrepParams`	`nocase()` Perform all predicate comparisons case-insensitively.
`ArgrepParams`	`or()` Combine multiple predicates with logical OR (the default if neither `and()` nor `or()` is set).
`static ArgrepParams`	`range(long start, long end)` Search the inclusive index range `[start, end]`.
`ArgrepParams`	`re(byte[] pattern)` Add a `RE` predicate: matches elements against a regular expression.
`ArgrepParams`	`re(java.lang.String pattern)` Add a `RE` predicate: matches elements against a regular expression.
`ArgrepParams`	`reversed()` Swap the start and end bounds.
`static ArgrepParams`	`to(long end)` Search from the start of the array to a concrete end index (wire start `-`).
`static ArgrepParams`	`unbounded()` Search the entire array (wire bounds `- +`).

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - unbounded
```
public static ArgrepParams unbounded()
```
    Search the entire array (wire bounds - +).
    
    Returns:
    
    a new ArgrepParams with start=-, end=+
  - range
```
public static ArgrepParams range(long start,
                                 long end)
```
    Search the inclusive index range [start, end].
    
    Parameters:
    
    start - the zero-based start index (inclusive)
    
    end - the zero-based end index (inclusive)
    
    Returns:
    
    a new ArgrepParams with concrete numeric bounds
  - from
```
public static ArgrepParams from(long start)
```
    Search from a concrete start index to the end of the array (wire end +).
    
    Parameters:
    
    start - the zero-based start index (inclusive)
    
    Returns:
    
    a new ArgrepParams with start=numeric, end=+
  - to
```
public static ArgrepParams to(long end)
```
    Search from the start of the array to a concrete end index (wire start -).
    
    Parameters:
    
    end - the zero-based end index (inclusive)
    
    Returns:
    
    a new ArgrepParams with start=-, end=numeric
  - reversed
```
public ArgrepParams reversed()
```
    Swap the start and end bounds. Because the server interprets start > end as a descending traversal, this returns matches in reverse index order.
    
    Returns:
    
    this ArgrepParams
  - exact
```
public ArgrepParams exact(java.lang.String value)
```
    Add an EXACT predicate: matches elements whose value equals the given string exactly.
    
    Parameters:
    
    value - the literal value to match against
    
    Returns:
    
    this ArgrepParams
  - exact
```
public ArgrepParams exact(byte[] value)
```
    Add an EXACT predicate: matches elements whose value equals the given bytes exactly.
    
    Parameters:
    
    value - the literal value to match against
    
    Returns:
    
    this ArgrepParams
  - match
```
public ArgrepParams match(java.lang.String value)
```
    Add a MATCH predicate: matches elements that contain the given string as a substring.
    
    Parameters:
    
    value - the substring to search for
    
    Returns:
    
    this ArgrepParams
  - match
```
public ArgrepParams match(byte[] value)
```
    Add a MATCH predicate: matches elements that contain the given bytes as a substring.
    
    Parameters:
    
    value - the substring to search for
    
    Returns:
    
    this ArgrepParams
  - glob
```
public ArgrepParams glob(java.lang.String pattern)
```
    Add a GLOB predicate: matches elements against a glob-style pattern (supports *, ? and [...]).
    
    Parameters:
    
    pattern - the glob pattern
    
    Returns:
    
    this ArgrepParams
  - glob
```
public ArgrepParams glob(byte[] pattern)
```
    Add a GLOB predicate: matches elements against a glob-style pattern (supports *, ? and [...]).
    
    Parameters:
    
    pattern - the glob pattern as raw bytes
    
    Returns:
    
    this ArgrepParams
  - re
```
public ArgrepParams re(java.lang.String pattern)
```
    Add a RE predicate: matches elements against a regular expression.
    
    Parameters:
    
    pattern - the regular expression
    
    Returns:
    
    this ArgrepParams
  - re
```
public ArgrepParams re(byte[] pattern)
```
    Add a RE predicate: matches elements against a regular expression.
    
    Parameters:
    
    pattern - the regular expression as raw bytes
    
    Returns:
    
    this ArgrepParams
  - and
```
public ArgrepParams and()
```
    Combine multiple predicates with logical AND.
    
    Returns:
    
    this ArgrepParams
  - or
```
public ArgrepParams or()
```
    Combine multiple predicates with logical OR (the default if neither and() nor or() is set).
    
    Returns:
    
    this ArgrepParams
  - limit
```
public ArgrepParams limit(long limit)
```
    Cap the number of matches returned.
    
    Parameters:
    
    limit - the maximum number of matches to return
    
    Returns:
    
    this ArgrepParams
  - nocase
```
public ArgrepParams nocase()
```
    Perform all predicate comparisons case-insensitively.
    
    Returns:
    
    this ArgrepParams
  - addParams
```
public void addParams(CommandArguments args)
```
    Specified by:
    
    addParams in interface IParams
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class ArgrepParams

Method Summary

Methods inherited from class java.lang.Object

Method Detail

unbounded

range

from

to

reversed

exact

exact

match

match

glob

glob

re

re

and

or

limit

nocase

addParams

equals

hashCode