redis.clients.jedis.JedisCommands Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jedis Show documentation
A java client for github.com/antirez/redis, a fork of github.com/xetorthio/jedis
The newest version!
package redis.clients.jedis;

import java.util.List;
import java.util.Map;
import java.util.Set;

import redis.clients.jedis.params.geo.GeoRadiusParam;
import redis.clients.jedis.params.sortedset.ZAddParams;
import redis.clients.jedis.params.sortedset.ZIncrByParams;

/**
 * Common interface for sharded and non-sharded Jedis
 */
public interface JedisCommands {
  String set(String key, String value);

  String set(String key, String value, String nxxx, String expx, long time);

  String set(String key, String value, String expx, long time);

  String set(String key, String value, String nxxx);

  String get(String key);

  Boolean exists(String key);

  Long persist(String key);

  String type(String key);

  byte[] dump(String key);

  String restore(String key, int ttl, byte[] serializedValue);

  Long expire(String key, int seconds);

  Long pexpire(String key, long milliseconds);

  Long expireAt(String key, long unixTime);

  Long pexpireAt(String key, long millisecondsTimestamp);

  Long ttl(String key);

  Long pttl(String key);

  Long touch(String key);

  Boolean setbit(String key, long offset, boolean value);

  Boolean setbit(String key, long offset, String value);

  Boolean getbit(String key, long offset);

  Long setrange(String key, long offset, String value);

  String getrange(String key, long startOffset, long endOffset);

  String getSet(String key, String value);

  Long setnx(String key, String value);

  String setex(String key, int seconds, String value);

  String psetex(String key, long milliseconds, String value);

  Long decrBy(String key, long decrement);

  Long decr(String key);

  Long incrBy(String key, long increment);

  Double incrByFloat(String key, double increment);

  Long incr(String key);

  Long append(String key, String value);

  String substr(String key, int start, int end);

  Long hset(String key, String field, String value);

  Long hset(String key, Map hash);

  String hget(String key, String field);

  Long hsetnx(String key, String field, String value);

  String hmset(String key, Map hash);

  List hmget(String key, String... fields);

  Long hincrBy(String key, String field, long value);

  Double hincrByFloat(String key, String field, double value);

  Boolean hexists(String key, String field);

  Long hdel(String key, String... field);

  Long hlen(String key);

  Set hkeys(String key);

  List hvals(String key);

  Map hgetAll(String key);

  Long rpush(String key, String... string);

  Long lpush(String key, String... string);

  Long llen(String key);

  List lrange(String key, long start, long stop);

  String ltrim(String key, long start, long stop);

  String lindex(String key, long index);

  String lset(String key, long index, String value);

  Long lrem(String key, long count, String value);

  String lpop(String key);

  String rpop(String key);

  Long sadd(String key, String... member);

  Set smembers(String key);

  Long srem(String key, String... member);

  String spop(String key);

  Set spop(String key, long count);

  Long scard(String key);

  Boolean sismember(String key, String member);

  String srandmember(String key);

  List srandmember(String key, int count);

  Long strlen(String key);

  Long zadd(String key, double score, String member);

  Long zadd(String key, double score, String member, ZAddParams params);

  Long zadd(String key, Map scoreMembers);

  Long zadd(String key, Map scoreMembers, ZAddParams params);

  Set zrange(String key, long start, long stop);

  Long zrem(String key, String... members);

  Double zincrby(String key, double increment, String member);

  Double zincrby(String key, double increment, String member, ZIncrByParams params);

  Long zrank(String key, String member);

  Long zrevrank(String key, String member);

  Set zrevrange(String key, long start, long stop);

  Set zrangeWithScores(String key, long start, long stop);

  Set zrevrangeWithScores(String key, long start, long stop);

  Long zcard(String key);

  Double zscore(String key, String member);

  List sort(String key);

  List sort(String key, SortingParams sortingParameters);

  Long zcount(String key, double min, double max);

  Long zcount(String key, String min, String max);

  Set zrangeByScore(String key, double min, double max);

  Set zrangeByScore(String key, String min, String max);

  Set zrevrangeByScore(String key, double max, double min);

  Set zrangeByScore(String key, double min, double max, int offset, int count);

  Set zrevrangeByScore(String key, String max, String min);

  Set zrangeByScore(String key, String min, String max, int offset, int count);

  Set zrevrangeByScore(String key, double max, double min, int offset, int count);

  Set zrangeByScoreWithScores(String key, double min, double max);

  Set zrevrangeByScoreWithScores(String key, double max, double min);

  Set zrangeByScoreWithScores(String key, double min, double max, int offset, int count);

  Set zrevrangeByScore(String key, String max, String min, int offset, int count);

  Set zrangeByScoreWithScores(String key, String min, String max);

  Set zrevrangeByScoreWithScores(String key, String max, String min);

  Set zrangeByScoreWithScores(String key, String min, String max, int offset, int count);

  Set zrevrangeByScoreWithScores(String key, double max, double min, int offset, int count);

  Set zrevrangeByScoreWithScores(String key, String max, String min, int offset, int count);

  Long zremrangeByRank(String key, long start, long stop);

  Long zremrangeByScore(String key, double min, double max);

  Long zremrangeByScore(String key, String min, String max);

  Long zlexcount(String key, String min, String max);

  Set zrangeByLex(String key, String min, String max);

  Set zrangeByLex(String key, String min, String max, int offset,
      int count);

  Set zrevrangeByLex(String key, String max, String min);

  Set zrevrangeByLex(String key, String max, String min,
      int offset, int count);

  Long zremrangeByLex(String key, String min, String max);

  @Deprecated
  Long linsert(String key, Client.LIST_POSITION where, String pivot, String value);
  Long linsert(String key, ListPosition where, String pivot, String value);

  Long lpushx(String key, String... string);

  Long rpushx(String key, String... string);

  /**
   * @deprecated unusable command, this will be removed in 3.0.0.
   */
  @Deprecated
  List blpop(String arg);

  List blpop(int timeout, String key);

  /**
   * @deprecated unusable command, this will be removed in 3.0.0.
   */
  @Deprecated
  List brpop(String arg);

  List brpop(int timeout, String key);

  Long del(String key);

  Long unlink(String key);

  String echo(String string);

  Long move(String key, int dbIndex);

  Long bitcount(String key);

  Long bitcount(String key, long start, long end);

  Long bitpos(String key, boolean value);

  Long bitpos(String key, boolean value, BitPosParams params);

  @Deprecated
  /**
   * This method is deprecated due to bug (scan cursor should be unsigned long)
   * And will be removed on next major release
   * @see https://github.com/xetorthio/jedis/issues/531 
   */
  ScanResult> hscan(final String key, int cursor);

  @Deprecated
  /**
   * This method is deprecated due to bug (scan cursor should be unsigned long)
   * And will be removed on next major release
   * @see https://github.com/xetorthio/jedis/issues/531 
   */
  ScanResult sscan(final String key, int cursor);

  @Deprecated
  /**
   * This method is deprecated due to bug (scan cursor should be unsigned long)
   * And will be removed on next major release
   * @see https://github.com/xetorthio/jedis/issues/531 
   */
  ScanResult zscan(final String key, int cursor);

  ScanResult> hscan(String key, String cursor);

  ScanResult> hscan(String key, String cursor,
      ScanParams params);

  ScanResult sscan(String key, String cursor);

  ScanResult sscan(final String key, final String cursor, final ScanParams params);

  ScanResult zscan(String key, String cursor);

  ScanResult zscan(String key, String cursor, ScanParams params);

  Long pfadd(String key, String... elements);

  Long pfcount(String key);

  // Geo Commands

  Long geoadd(String key, double longitude, double latitude, String member);

  Long geoadd(String key, Map memberCoordinateMap);

  Double geodist(String key, String member1, String member2);

  Double geodist(String key, String member1, String member2, GeoUnit unit);

  List geohash(String key, String... members);

  List geopos(String key, String... members);

  List georadius(String key, double longitude, double latitude, double radius,
      GeoUnit unit);

  List georadius(String key, double longitude, double latitude, double radius,
      GeoUnit unit, GeoRadiusParam param);

  List georadiusByMember(String key, String member, double radius, GeoUnit unit);

  List georadiusByMember(String key, String member, double radius, GeoUnit unit,
      GeoRadiusParam param);

  /**
   * Executes BITFIELD Redis command
   * @param key
   * @param arguments
   */
  List bitfield(String key, String...arguments);
  
  /**
   * Used for HSTRLEN Redis command
   * @param key 
   * @param field
   * @return lenth of the value for key
   */
  Long hstrlen(String key, String field);
}