io.lettuce.core

Class LcsArgs

java.lang.Object

io.lettuce.core.LcsArgs

All Implemented Interfaces:

CompositeArgument

public class LcsArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis LCS command. Static import the methods from LcsArgs.Builder and call the methods.

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

Since:

6.6

Author:

Seonghwan Lee, Yordan Tsintsov

See Also:

LCS command reference

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
LcsArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
LcsArgs	by(String... keys) Deprecated. since 7.8, pass the keys to RedisStringCommands.lcs(Object, Object, LcsArgs) instead; scheduled for removal in a future major release. Keys set through this method are encoded as plain strings and not through the key codec, so they neither work with non-String key codecs nor participate in Redis Cluster slot routing.
boolean	isWithIdx()
LcsArgs	justLen() Request just the length of the match for results.
LcsArgs	minMatchLen(int minMatchLen) Restrict the list of matches to the ones of a given minimal length.
LcsArgs	withIdx() Request match position in each string for results.
LcsArgs	withMatchLen() Request match len for results.

Methods inherited from class java.lang.Object

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

Constructor Detail

LcsArgs

public LcsArgs()

Method Detail

minMatchLen

public LcsArgs minMatchLen(int minMatchLen)

Restrict the list of matches to the ones of a given minimal length.

Returns:

this LcsArgs.

justLen

public LcsArgs justLen()

Request just the length of the match for results.

Returns:

this LcsArgs.

withMatchLen

public LcsArgs withMatchLen()

Request match len for results.

Returns:

this LcsArgs.

withIdx

public LcsArgs withIdx()

Request match position in each string for results.

Returns:

this LcsArgs.

by

@Deprecated
public LcsArgs by(String... keys)

Deprecated. since 7.8, pass the keys to RedisStringCommands.lcs(Object, Object, LcsArgs) instead; scheduled for removal in a future major release. Keys set through this method are encoded as plain strings and not through the key codec, so they neither work with non-String key codecs nor participate in Redis Cluster slot routing.

Set the keys.

Parameters:

keys - the keys, must not be empty.

Returns:

this LcsArgs.

Throws:

IllegalArgumentException - if keys is null or empty.

isWithIdx

public boolean isWithIdx()

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.