io.lettuce.core

Class ZStoreArgs

java.lang.Object

io.lettuce.core.ZStoreArgs

All Implemented Interfaces:

CompositeArgument

public class ZStoreArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis ZUNIONSTORE and ZINTERSTORE commands. Static import the methods from ZStoreArgs.Builder and chain the method calls: weights(1, 2).max().

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

Author:

Will Glozer, Xy Ma, Mark Paluch

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ZStoreArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
ZStoreArgs	max() Aggregate scores of elements existing across multiple sets by using the highest score.
ZStoreArgs	min() Aggregate scores of elements existing across multiple sets by using the lowest score.
ZStoreArgs	sum() Aggregate scores of elements existing across multiple sets by summing up.
ZStoreArgs	weights(double... weights) Specify a multiplication factor for each input sorted set.
static ZStoreArgs	weights(long[] weights) Deprecated. use weights(double...)

Methods inherited from class java.lang.Object

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

Constructor Detail

ZStoreArgs

public ZStoreArgs()

Method Detail

weights

@Deprecated
public static ZStoreArgs weights(long[] weights)

Deprecated. use weights(double...)

Specify a multiplication factor for each input sorted set.

Parameters:

weights - must not be null.

Returns:

this ZStoreArgs.

weights

public ZStoreArgs weights(double... weights)

Specify a multiplication factor for each input sorted set.

Parameters:

weights - must not be null.

Returns:

this ZStoreArgs.

sum

public ZStoreArgs sum()

Aggregate scores of elements existing across multiple sets by summing up.

Returns:

this ZStoreArgs.

min

public ZStoreArgs min()

Aggregate scores of elements existing across multiple sets by using the lowest score.

Returns:

this ZStoreArgs.

max

public ZStoreArgs max()

Aggregate scores of elements existing across multiple sets by using the highest score.

Returns:

this ZStoreArgs.

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.