io.lettuce.core.json.arguments

Class JsonGetArgs

java.lang.Object

io.lettuce.core.json.arguments.JsonGetArgs

All Implemented Interfaces:

CompositeArgument

public class JsonGetArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis JSON.GET command.

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

Since:

6.5

Author:

Tihomir Mateev

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
JsonGetArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
JsonGetArgs	defaults() Set empty arguments.
JsonGetArgs	indent(String indent) Set the string used for indentation.
JsonGetArgs	newline(String newline) Set the string used for newline.
JsonGetArgs	space(String space) Set the string used for spacing.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonGetArgs

public JsonGetArgs()

Method Detail

indent

public JsonGetArgs indent(String indent)

Set the string used for indentation.

Returns:

this.

newline

public JsonGetArgs newline(String newline)

Set the string used for newline.

Returns:

this.

space

public JsonGetArgs space(String space)

Set the string used for spacing.

Returns:

this.

defaults

public JsonGetArgs defaults()

Set empty arguments.

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.