io.lettuce.core.json.arguments

Class JsonRangeArgs

java.lang.Object

io.lettuce.core.json.arguments.JsonRangeArgs

All Implemented Interfaces:

CompositeArgument

public class JsonRangeArgs
extends Object
implements CompositeArgument

Argument list builder for the RedisJSON commands that require ranges. By default, start and end indexes are set to 0. Modifying these values might have different effects depending on the command they are supplied to.

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

Since:

6.5

Author:

Tihomir Mateev

See Also:

JSON.ARRINDEX, JSON.ARRTRIM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonRangeArgs.Builder Builder entry points for JsonRangeArgs.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_END_INDEX Default end index to indicate where to stop slicing the array
static int	DEFAULT_START_INDEX Default start index to indicate where to start slicing the array

Constructor Summary

Constructors

Constructor and Description
JsonRangeArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
JsonRangeArgs	start(long start) Set the start index.
JsonRangeArgs	stop(long stop) Set the end index.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_START_INDEX

public static final int DEFAULT_START_INDEX

Default start index to indicate where to start slicing the array

See Also:

Constant Field Values

DEFAULT_END_INDEX

public static final int DEFAULT_END_INDEX

Default end index to indicate where to stop slicing the array

See Also:

Constant Field Values

Constructor Detail

JsonRangeArgs

public JsonRangeArgs()

Method Detail

start

public JsonRangeArgs start(long start)

Set the start index.

Returns:

this.

stop

public JsonRangeArgs stop(long stop)

Set the end index.

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.