io.lettuce.core

Class XPendingArgs<K>

java.lang.Object

io.lettuce.core.XPendingArgs<K>

All Implemented Interfaces:

CompositeArgument

public class XPendingArgs<K>
extends Object
implements CompositeArgument

Argument list builder for the Redis XPENDING command. Static import the methods from XPendingArgs.Builder and call the methods: block(…) .

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

Since:

6.1

Author:

dengliming

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
XPendingArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
XPendingArgs<K>	consumer(Consumer<K> consumer)
XPendingArgs<K>	group(K group)
XPendingArgs<K>	idle(Duration timeout) Include only entries that are idle for Duration.
XPendingArgs<K>	idle(long milliseconds) Include only entries that are idle for milliseconds.
XPendingArgs<K>	limit(Limit limit)
XPendingArgs<K>	range(Range<String> range)

Methods inherited from class java.lang.Object

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

Constructor Detail

XPendingArgs

public XPendingArgs()

Method Detail

range

public XPendingArgs<K> range(Range<String> range)

consumer

public XPendingArgs<K> consumer(Consumer<K> consumer)

group

public XPendingArgs<K> group(K group)

Parameters:

group -

Returns:

Since:

6.1.9

limit

public XPendingArgs<K> limit(Limit limit)

idle

public XPendingArgs<K> idle(Duration timeout)

Include only entries that are idle for Duration.

Parameters:

timeout -

Returns:

this XPendingArgs.

idle

public XPendingArgs<K> idle(long milliseconds)

Include only entries that are idle for milliseconds.

Parameters:

milliseconds -

Returns:

this XPendingArgs.

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.