redis.clients.jedis.params.ZIncrByParams Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jredisearch-jedis Show documentation

Jedis is a blazingly small and sane Redis java client. This is a fork of master

The newest version!

package redis.clients.jedis.params;

import redis.clients.jedis.util.SafeEncoder;

import java.util.ArrayList;

/**
 * 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. 

 * http://redis.io/commands/zadd 

 * 

 * So we decided to wrap "ZADD with INCR option" to ZINCRBY. 

 * https://github.com/xetorthio/jedis/issues/1067 

 * 

 * Works with Redis 3.0.2 and onwards.
 */
public class ZIncrByParams extends Params {

  private static final String XX = "xx";
  private static final String NX = "nx";
  private static final String INCR = "incr";

  public ZIncrByParams() {
  }

  public static ZIncrByParams zIncrByParams() {
    return new ZIncrByParams();
  }

  /**
   * Only set the key if it does not already exist.
   * @return ZIncrByParams
   */
  public ZIncrByParams nx() {
    addParam(NX);
    return this;
  }

  /**
   * Only set the key if it already exist.
   * @return ZIncrByParams
   */
  public ZIncrByParams xx() {
    addParam(XX);
    return this;
  }

  public byte[][] getByteParams(byte[] key, byte[]... args) {
    ArrayList byteParams = new ArrayList();
    byteParams.add(key);

    if (contains(NX)) {
      byteParams.add(SafeEncoder.encode(NX));
    }
    if (contains(XX)) {
      byteParams.add(SafeEncoder.encode(XX));
    }

    byteParams.add(SafeEncoder.encode(INCR));

    for (byte[] arg : args) {
      byteParams.add(arg);
    }

    return byteParams.toArray(new byte[byteParams.size()][]);
  }

}