io.lettuce.core.json.arguments

Class JsonSetArgs

java.lang.Object

io.lettuce.core.json.arguments.JsonSetArgs

All Implemented Interfaces:

CompositeArgument

public class JsonSetArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis JSON.SET command.

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

Since:

6.5

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonSetArgs.Builder Builder entry points for JsonSetArgs.
static class	JsonSetArgs.FphaType Floating-point homogeneous array type for the FPHA block of the JSON.SET command.

Constructor Summary

Constructors

Constructor and Description
JsonSetArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
JsonSetArgs	defaults() Set the key only if it already exists.
JsonSetArgs	fpha(JsonSetArgs.FphaType fphaType) Set the floating-point homogeneous array type for encoding numeric arrays.
JsonSetArgs	nx() Set the key only if it does not already exist.
JsonSetArgs	xx() Set the key only if it already exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonSetArgs

public JsonSetArgs()

Method Detail

nx

public JsonSetArgs nx()

Set the key only if it does not already exist.

Returns:

this.

xx

public JsonSetArgs xx()

Set the key only if it already exists.

Returns:

this.

fpha

public JsonSetArgs fpha(JsonSetArgs.FphaType fphaType)

Set the floating-point homogeneous array type for encoding numeric arrays.

Parameters:

fphaType - the floating-point homogeneous array type.

Returns:

this.

Since:

7.6

defaults

public JsonSetArgs defaults()

Set the key only if it already exists.

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.