ArGrepArgs (Lettuce 7.7.0.RELEASE API)

java.lang.Object
- io.lettuce.core.array.ArGrepArgs

All Implemented Interfaces:: CompositeArgument

@Experimental
public class ArGrepArgs
extends Object
implements CompositeArgument

Argument builder for the Redis ARGREP command.

Bundles the range (start/end), one or more predicates, optional AND/OR combiner, LIMIT, and NOCASE flags.

A null lower bound maps to the Redis - token and a null upper bound maps to +.

Example usage:

 ArGrepArgs.unbounded().exact("hello");
 ArGrepArgs.range(0, 100).match("world").nocase();
 ArGrepArgs.from(5).glob("prefix*");
 ArGrepArgs.to(100).re("^foo.*");
 ArGrepArgs.unbounded().re("^foo.*").glob("bar*").and().limit(10);
 ArGrepArgs.unbounded().reversed().exact("hello"); // all elements, descending
 ArGrepArgs.range(3, 7).reversed().exact("foo"); // elements in [3,7], descending

ArGrepArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:: 7.6
Author:: Aleksandar Todorov
See Also:: Redis Documentation: ARGREP

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArGrepArgs`	`and()` Sets the predicate combiner to AND (default is OR).
`<K,V> void`	`build(CommandArgs<K,V> args)` Build command arguments and contribute arguments to `CommandArgs`.
`ArGrepArgs`	`exact(String value)` Adds an EXACT predicate.
`static ArGrepArgs`	`from(long start)` Creates a new `ArGrepArgs` with a lower bound only (`start +` in Redis).
`ArGrepArgs`	`glob(String pattern)` Adds a GLOB predicate.
`ArGrepArgs`	`limit(long limit)` Sets the maximum number of results to return.
`ArGrepArgs`	`match(String value)` Adds a MATCH (substring) predicate.
`ArGrepArgs`	`nocase()` Enables case-insensitive matching.
`static ArGrepArgs`	`range(long start, long end)` Creates a new `ArGrepArgs` with a bounded range.
`ArGrepArgs`	`re(String pattern)` Adds a RE (regex) predicate.
`ArGrepArgs`	`reversed()` Reverses the iteration order.
`static ArGrepArgs`	`to(long end)` Creates a new `ArGrepArgs` with an upper bound only (`- end` in Redis).
`static ArGrepArgs`	`unbounded()` Creates a new `ArGrepArgs` with an unbounded range (`- +` in Redis).

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

- Method Detail
  - unbounded
```
public static ArGrepArgs unbounded()
```
    Creates a new ArGrepArgs with an unbounded range (- + in Redis).
    
    Returns:
    
    a new ArGrepArgs instance.
  - range
```
public static ArGrepArgs range(long start,
                               long end)
```
    Creates a new ArGrepArgs with a bounded range.
    
    Parameters:
    
    start - the start index (inclusive).
    
    end - the end index (inclusive).
    
    Returns:
    
    a new ArGrepArgs instance.
  - from
```
public static ArGrepArgs from(long start)
```
    Creates a new ArGrepArgs with a lower bound only (start + in Redis).
    
    Parameters:
    
    start - the start index (inclusive); upper bound is unbounded.
    
    Returns:
    
    a new ArGrepArgs instance.
  - to
```
public static ArGrepArgs to(long end)
```
    Creates a new ArGrepArgs with an upper bound only (- end in Redis).
    
    Parameters:
    
    end - the end index (inclusive); lower bound is unbounded.
    
    Returns:
    
    a new ArGrepArgs instance.
  - exact
```
public ArGrepArgs exact(String value)
```
    Adds an EXACT predicate.
    
    Parameters:
    
    value - the exact value to match.
    
    Returns:
    
    this.
  - match
```
public ArGrepArgs match(String value)
```
    Adds a MATCH (substring) predicate.
    
    Parameters:
    
    value - the substring to match.
    
    Returns:
    
    this.
  - glob
```
public ArGrepArgs glob(String pattern)
```
    Adds a GLOB predicate.
    
    Parameters:
    
    pattern - the glob pattern.
    
    Returns:
    
    this.
  - re
```
public ArGrepArgs re(String pattern)
```
    Adds a RE (regex) predicate.
    
    Parameters:
    
    pattern - the regex pattern.
    
    Returns:
    
    this.
  - and
```
public ArGrepArgs and()
```
    Sets the predicate combiner to AND (default is OR).
    
    Returns:
    
    this.
  - limit
```
public ArGrepArgs limit(long limit)
```
    Sets the maximum number of results to return.
    
    Parameters:
    
    limit - the limit.
    
    Returns:
    
    this.
  - nocase
```
public ArGrepArgs nocase()
```
    Enables case-insensitive matching.
    
    Returns:
    
    this.
  - reversed
```
public ArGrepArgs reversed()
```
    Reverses the iteration order. The same elements are matched, but results are returned in descending index order instead of ascending.
    On the wire, this swaps the two range arguments (e.g. 3 7 becomes 7 3).
    
    Returns:
    
    this.
  - build
```
public <K,V> void build(CommandArgs<K,V> args)
```
    Description copied from interface: CompositeArgument
    
    Build command arguments and contribute arguments to CommandArgs.
    Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.
    
    Specified by:
    
    build in interface CompositeArgument
    
    Type Parameters:
    
    K - Key type.
    
    V - Value type.
    
    Parameters:
    
    args - the command arguments, must not be null.

Class ArGrepArgs

Method Summary

Methods inherited from class java.lang.Object

Method Detail

unbounded

range

from

to

exact

match

glob

re

and

limit

nocase

reversed

build