Package redis.clients.jedis.params

Class ZIncrByParams

java.lang.Object

redis.clients.jedis.params.Params

redis.clients.jedis.params.ZIncrByParams

All Implemented Interfaces:

IParams

public class ZIncrByParams
extends Params
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.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	INCR
private static final String	NX
private static final String	XX

Constructor Summary

Constructors

Constructor	Description
ZIncrByParams()

Method Summary

Modifier and Type	Method	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 redis.clients.jedis.params.Params

addParam, addParam, contains, getByteParams, getParam, toString

Methods inherited from class java.lang.Object

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

Field Details

XX

private static final String XX

See Also:

• Constant Field Values

NX

private static final String NX

See Also:

• Constant Field Values

INCR

private static final String INCR

See Also:

• Constant Field Values

Constructor Details

ZIncrByParams

public ZIncrByParams()

Method Details

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