io.lettuce.core

Class ZPopArgs

java.lang.Object

io.lettuce.core.ZPopArgs

All Implemented Interfaces:

CompositeArgument

public class ZPopArgs
extends Object
implements CompositeArgument

Argument list builder for the ZMPOP ZMPOP and BZMPOP command starting. ZPopArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:

6.3

Author:

Mark Paluch

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ZPopArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
ZPopArgs	max() Elements popped are those with the highest scores from the first non-empty sorted set
ZPopArgs	min() Elements popped are those with the lowest scores from the first non-empty sorted set

Methods inherited from class java.lang.Object

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

Constructor Detail

ZPopArgs

public ZPopArgs()

Method Detail

min

public ZPopArgs min()

Elements popped are those with the lowest scores from the first non-empty sorted set

Returns:

this ZPopArgs.

max

public ZPopArgs max()

Elements popped are those with the highest scores from the first non-empty sorted set

Returns:

this ZPopArgs.

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.