io.lettuce.core

Class CompareCondition<V>

java.lang.Object

io.lettuce.core.CompareCondition<V>

Type Parameters:

V - value type used for value-based comparisons

@Experimental
public final class CompareCondition<V>
extends Object

A compare condition to be used with commands that support conditional value checks (e.g. SET with IFEQ/IFNE/IFDEQ/IFDNE and DELEX). This abstraction lets callers express value-based or digest-based comparisons.

Digest-based comparisons use a 64-bit XXH3 digest represented as a 16-character lower-case hexadecimal string.

Since:

7.1

Author:

Aleksandar Todorov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompareCondition.Condition The kind of condition represented by this instance.

Method Summary

Modifier and Type	Method and Description
<K> void	build(CommandArgs<K,V> args) Append this condition's protocol arguments to the given args.
static <V> CompareCondition<V>	digestEq(String hex16Digest) Create a digest-based equality condition; succeeds only if the current value's digest matches the given 16-character lower-case hex digest.
static <V> CompareCondition<V>	digestNe(String hex16Digest) Create a digest-based inequality condition; succeeds only if the current value's digest does not match the given 16-character lower-case hex digest.
CompareCondition.Condition	getCondition() The kind of this condition.
String	getDigest() The 16-character lower-case hex digest for digest-based comparisons, or null.
V	getValue() The value for value-based comparisons, or null.
String	toString()
static <V> CompareCondition<V>	valueEq(V value) Create a value-based equality condition; succeeds only if the current value equals the given value.
static <V> CompareCondition<V>	valueNe(V value) Create a value-based inequality condition; succeeds only if the current value does not equal the given value.

Methods inherited from class java.lang.Object

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

Method Detail

build

public <K> void build(CommandArgs<K,V> args)

Append this condition's protocol arguments to the given args.

valueEq

public static <V> CompareCondition<V> valueEq(V value)

Create a value-based equality condition; succeeds only if the current value equals the given value.

valueNe

public static <V> CompareCondition<V> valueNe(V value)

Create a value-based inequality condition; succeeds only if the current value does not equal the given value.

digestEq

public static <V> CompareCondition<V> digestEq(String hex16Digest)

Create a digest-based equality condition; succeeds only if the current value's digest matches the given 16-character lower-case hex digest.

digestNe

public static <V> CompareCondition<V> digestNe(String hex16Digest)

Create a digest-based inequality condition; succeeds only if the current value's digest does not match the given 16-character lower-case hex digest.

getCondition

public CompareCondition.Condition getCondition()

The kind of this condition.

getValue

public V getValue()

The value for value-based comparisons, or null.

getDigest

public String getDigest()

The 16-character lower-case hex digest for digest-based comparisons, or null.

toString

public String toString()

Overrides:

toString in class Object