io.lettuce.core

Class LMovemArgs

java.lang.Object

io.lettuce.core.LMovemArgs

All Implemented Interfaces:

CompositeArgument

public class LMovemArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis BLMOVEM and LMOVEM commands. Static import the methods from LMovemArgs.Builder and chain the method calls: leftRight().count(2, Ordering.BULK).

Directions (LEFT/RIGHT) are mandatory. The COUNT/EXACTLY block is optional; when applied it requires an LMovemArgs.Ordering (OBO or BULK). Without a count block LMOVEM and BLMOVEM are equivalent to LMOVE and BLMOVE.

Since:

7.7

Author:

Aleksandar Todorov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LMovemArgs.Builder Builder entry points for LMovemArgs.
static class	LMovemArgs.Ordering Ordering in which the moved elements are popped from the source and pushed to the destination.

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
LMovemArgs	count(long count, LMovemArgs.Ordering ordering) Move up-to count elements.
LMovemArgs	exactly(long count, LMovemArgs.Ordering ordering) Move exactly count elements or return an empty list if the source list does not have enough elements.

Methods inherited from class java.lang.Object

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

Method Detail

count

public LMovemArgs count(long count,
                        LMovemArgs.Ordering ordering)

Move up-to count elements. Follows the same semantics as the count parameter of LPOP.

Parameters:

count - the maximum number of elements to move.

ordering - the LMovemArgs.Ordering in which the elements are moved, must not be null.

Returns:

this LMovemArgs.

exactly

public LMovemArgs exactly(long count,
                          LMovemArgs.Ordering ordering)

Move exactly count elements or return an empty list if the source list does not have enough elements.

Parameters:

count - the exact number of elements to move.

ordering - the LMovemArgs.Ordering in which the elements are moved, must not be null.

Returns:

this LMovemArgs.

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.