io.lettuce.core

Class BLMovemArgs

java.lang.Object

io.lettuce.core.BLMovemArgs

All Implemented Interfaces:

CompositeArgument

public class BLMovemArgs
extends Object
implements CompositeArgument

Argument list builder for the blocking Redis BLMOVEM command. Wraps the directions and optional count block of an LMovemArgs and adds the mandatory timeout that BLMOVEM places between them. Static import the methods from BLMovemArgs.Builder and chain the method calls: leftRight().count(2, Ordering.BULK).timeout(1.5).

The timeout defaults to 0 (block indefinitely) when not set explicitly. This type intentionally does not extend LMovemArgs so that it cannot be passed to the non-blocking lmovem command, which would emit an invalid LMOVEM carrying a timeout.

Since:

7.7

Author:

Aleksandar Todorov

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
BLMovemArgs	count(long count, LMovemArgs.Ordering ordering) Move up-to count elements.
BLMovemArgs	exactly(long count, LMovemArgs.Ordering ordering) Move exactly count elements or return an empty list if the source list does not have enough elements.
BLMovemArgs	timeout(double timeout) Set the blocking timeout in seconds, allowing for sub-second resolution.
BLMovemArgs	timeout(long timeout) Set the blocking timeout in seconds.

Methods inherited from class java.lang.Object

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

Method Detail

timeout

public BLMovemArgs timeout(long timeout)

Set the blocking timeout in seconds.

Parameters:

timeout - the timeout in seconds.

Returns:

this BLMovemArgs.

timeout

public BLMovemArgs timeout(double timeout)

Set the blocking timeout in seconds, allowing for sub-second resolution.

Parameters:

timeout - the timeout in seconds.

Returns:

this BLMovemArgs.

count

public BLMovemArgs 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 BLMovemArgs.

exactly

public BLMovemArgs 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 BLMovemArgs.

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.