redis.clients.jedis.params

Class ZIncrByParams

java.lang.Object

redis.clients.jedis.params.ZIncrByParams

All Implemented Interfaces:

IParams

public class ZIncrByParams
extends java.lang.Object
implements IParams

Parameters for ZINCRBY commands. In fact, Redis doesn't have parameters for ZINCRBY. Instead Redis has INCR parameter for ZADD.

When users call ZADD with INCR option, its restriction (only one member) and return type is same to ZINCRBY. Document page for ZADD also describes INCR option to act like ZINCRBY. So we decided to wrap "ZADD with INCR option" to ZINCRBY.

Works with Redis 3.0.2 and onwards.

Constructor Summary

Constructors

Constructor and Description
ZIncrByParams()

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
ZIncrByParams	nx() Only set the key if it does not already exist.
ZIncrByParams	xx() Only set the key if it already exist.
static ZIncrByParams	zIncrByParams()

Methods inherited from class java.lang.Object

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

Constructor Detail

ZIncrByParams

public ZIncrByParams()

Method Detail

zIncrByParams

public static ZIncrByParams zIncrByParams()

nx

public ZIncrByParams nx()

Only set the key if it does not already exist.

Returns:

ZIncrByParams

xx

public ZIncrByParams xx()

Only set the key if it already exist.

Returns:

ZIncrByParams

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams