org.rarefiedredis.redis

Interface IRedisString

All Known Subinterfaces:

IRedisClient

All Known Implementing Classes:

AbstractJedisIRedisClient, AbstractRedisClient, AbstractRedisMock, JedisIRedisClient, JedisIRedisClientMulti, RedisMock, RedisMockClient, RedisMockMulti

public interface IRedisString

Interface for redis string commands.

Method Summary

Modifier and Type	Method and Description
Long	append(String key, String value) Append value onto key.
Long	bitcount(String key, long... options) Count the number of set bits in a string.
Long	bitop(String operation, String destkey, String... keys) Perform a bitwise operation between multiple keys and store the result in the destination key.
Long	bitpos(String key, long bit, long... options) Return the position of the first bit set to 0 or 1 in a string.
Long	decr(String key) Decrement the number stored at key by one.
Long	decrby(String key, long decrement) Decrement the number stored at key by the given decrement.
String	get(String key) Get the value of a key.
Boolean	getbit(String key, long offset) Returns the bit value at offset in the string value stored at key.
String	getrange(String key, long start, long end) Returns the substring of the string value stored at key, determined by the inclusive offsets start and end.
String	getset(String key, String value) Atomically set a key and return its previous value.
Long	incr(String key) Increment the number stored at key by one.
Long	incrby(String key, long increment) Increment the number stored at key by the given increment.
String	incrbyfloat(String key, double increment) Increment the number stored at key by the given increment.
String[]	mget(String... keys) Returns the values of all specified keys.
String	mset(String... keysvalues) Sets the given keys to their respective values.
Boolean	msetnx(String... keysvalues) Sets the given keys to their respective values.
String	psetex(String key, long milliseconds, String value) Set and expire a key in milliseconds.
String	set(String key, String value, String... options) Set key to hold the string value.
Long	setbit(String key, long offset, boolean value) Sets or clears the bit at offset in the string value stored at key.
String	setex(String key, int seconds, String value) Set and expire a key in seconds.
Long	setnx(String key, String value) Set a key only if it does not already exist.
Long	setrange(String key, long offset, String value) Ovewrite part of the string starting at offset with value.
Long	strlen(String key) Return the length of the string at key.

Method Detail

append

Long append(String key,
            String value)
     throws WrongTypeException,
            NotImplementedException

Append value onto key.

Parameters:

key - The key

value - The value

Returns:

The length of the key after the append operation.

Throws:

WrongTypeException - If key is not a string

NotImplementedException - If the command is unimplemented.

bitcount

Long bitcount(String key,
              long... options)
       throws WrongTypeException,
              NotImplementedException

Count the number of set bits in a string.

Parameters:

key - The key

options - start, end

Returns:

The number of bits in the string set to 1

Throws:

WrongTypeException - If key is not a string

NotImplementedException - If the command is unimplemented.

bitop

Long bitop(String operation,
           String destkey,
           String... keys)
    throws WrongTypeException,
           NotImplementedException

Perform a bitwise operation between multiple keys and store the result in the destination key.

Parameters:

operation - The operation to perform. Valid values are "and", "or", "xor", and "not".

destkey - The destination key to store the operation result in.

keys - The keys to operate against.

Returns:

The length of the string stored in destkey

Throws:

WrongTypeException - If key is not a string

NotImplementedException - If the command is unimplemented.

bitpos

Long bitpos(String key,
            long bit,
            long... options)
     throws WrongTypeException,
            BitArgException,
            NotImplementedException

Return the position of the first bit set to 0 or 1 in a string.

Parameters:

key - The key

bit - 0|1

options - start, end

Returns:

The bit position.

Throws:

WrongTypeException - If key is not a string

BitArgException - If bit is not equal to 0 or 1

NotImplementedException - If the command is unimplemented.

decr

Long decr(String key)
   throws WrongTypeException,
          NotIntegerException,
          NotImplementedException

Decrement the number stored at key by one.

Parameters:

key - The key

Returns:

The new value of the string after the decrement operation, i.e., value - 1

Throws:

WrongTypeException - If key is not a string

NotIntegerException - If key does not hold an integer value

NotImplementedException - If the command is unimplemented.

decrby

Long decrby(String key,
            long decrement)
     throws WrongTypeException,
            NotIntegerException,
            NotImplementedException

Decrement the number stored at key by the given decrement.

Parameters:

key - The key

decrement - The number to decrement by

Returns:

The new value of the string after the decrement operation, i.e., value - decrement

Throws:

WrongTypeException - If key is not a string

NotIntegerException - If key does not hold an integer value

NotImplementedException - If the command is unimplemented.

get

String get(String key)
    throws WrongTypeException,
           NotImplementedException

Get the value of a key.

Parameters:

key - The key

Returns:

The value of key

Throws:

WrongTypeException - If key is not a string

NotImplementedException - If the command is unimplemented.

getbit

Boolean getbit(String key,
               long offset)
        throws WrongTypeException,
               NotImplementedException

Returns the bit value at offset in the string value stored at key.

Parameters:

key - The key

offset - The offset within the string

Returns:

The bit value at offset

Throws:

WrongTypeException - If key is not a string

NotImplementedException - If the command is unimplemented.

getrange

String getrange(String key,
                long start,
                long end)
         throws WrongTypeException,
                NotImplementedException

Returns the substring of the string value stored at key, determined by the inclusive offsets start and end.

Parameters:

key - The key

start - The start index of the range

end - The end index of the range

Returns:

The range

Throws:

WrongTypeException - If key is not a string

NotImplementedException - If the command is unimplemented.

getset

String getset(String key,
              String value)
       throws WrongTypeException,
              NotImplementedException

Atomically set a key and return its previous value.

Parameters:

key - The key

value - The new value

Returns:

The previous value

Throws:

WrongTypeException - If key is not a string

NotImplementedException - If the command is unimplemented.

incr

Long incr(String key)
   throws WrongTypeException,
          NotIntegerException,
          NotImplementedException

Increment the number stored at key by one.

Parameters:

key - The key

Returns:

The new value of the string after the decrement operation, i.e., value + 1

Throws:

WrongTypeException - If key is not a string

NotIntegerException - If key does not hold an integer value

NotImplementedException - If the command is unimplemented.

incrby

Long incrby(String key,
            long increment)
     throws WrongTypeException,
            NotIntegerException,
            NotImplementedException

Increment the number stored at key by the given increment.

Parameters:

key - The key

increment - The increment to increase the key by

Returns:

The new value of the string after the decrement operation, i.e., value + increment

Throws:

WrongTypeException - If key is not a string

NotIntegerException - If key does not hold an integer value

NotImplementedException - If the command is unimplemented.

incrbyfloat

String incrbyfloat(String key,
                   double increment)
            throws WrongTypeException,
                   NotFloatException,
                   NotImplementedException

Increment the number stored at key by the given increment.

Parameters:

key - The key

increment - The increment to increase the key by

Returns:

The new value of the string after the decrement operation, i.e., value + increment, as a string.

Throws:

WrongTypeException - If key is not a string

NotFloatException - If key does not hold a floating point value

NotImplementedException - If the command is unimplemented.

mget

String[] mget(String... keys)
       throws NotImplementedException

Returns the values of all specified keys. If a given key does not hold a string value, or does not exist, null is returned for that key in the returned array.

Parameters:

keys - The keys to get

Returns:

List of values at the specified keys

Throws:

NotImplementedException - If the command is unimplemented.

mset

String mset(String... keysvalues)
     throws ArgException,
            NotImplementedException

Sets the given keys to their respective values. Existing keys will be overwritten.

Parameters:

keysvalues - The key-value pairs to set.

Returns:

"OK"

Throws:

ArgException - If the given arguments are not valid

NotImplementedException - If the command is unimplemented.

msetnx

Boolean msetnx(String... keysvalues)
        throws ArgException,
               NotImplementedException

Sets the given keys to their respective values. If at least one of the keys already exists, none of the keys are set.

Parameters:

keysvalues - The key-value pairs to set.

Returns:

1 if all of the keys were set, or 0 if at least 1 key already existed and no operation was performed.

Throws:

ArgException - If the given arguments are not valid

NotImplementedException - If the command is unimplemented.

psetex

String psetex(String key,
              long milliseconds,
              String value)
       throws NotImplementedException

Set and expire a key in milliseconds.

Parameters:

key - The key

milliseconds - The expiry time in milliseconds

value - The value

Returns:

"OK"

Throws:

NotImplementedException - If the command is unimplemented.

set

String set(String key,
           String value,
           String... options)
    throws NotImplementedException,
           SyntaxErrorException

Set key to hold the string value.

Parameters:

key - The key

value - The value

options - nx|xx, ex|px timeout.

Returns:

"OK" if the key was set, or null if the operation failed.

Throws:

NotImplementedException - If the command is unimplemented.

SyntaxErrorException - If the given options were not valid.

setbit

Long setbit(String key,
            long offset,
            boolean value)
     throws WrongTypeException,
            NotImplementedException

Sets or clears the bit at offset in the string value stored at key.

Parameters:

key - The key

offset - The offset

value - Whether to set or clear the bit (set = true, clear = false)

Returns:

The original bit value at offset

Throws:

WrongTypeException - If key is not a string

NotImplementedException - If the command is unimplemented.

setex

String setex(String key,
             int seconds,
             String value)
      throws NotImplementedException

Set and expire a key in seconds.

Parameters:

key - The key

seconds - The expiry time in seconds

value - The value

Returns:

"OK"

Throws:

NotImplementedException - If the command is unimplemented.

setnx

Long setnx(String key,
           String value)
    throws NotImplementedException

Set a key only if it does not already exist.

Parameters:

key - The key

value - The value

Returns:

1 if the key was set; 0 if it already existed and no operation was performed.

Throws:

NotImplementedException - If the command is unimplemented.

setrange

Long setrange(String key,
              long offset,
              String value)
       throws WrongTypeException,
              NotImplementedException

Ovewrite part of the string starting at offset with value.

Parameters:

key - The key

offset - Where to start. If greater than the length of the string, the string is padded out to the offset.

value - The value

Returns:

The length of the string after this operation

Throws:

WrongTypeException - If key is not a string

NotImplementedException - If the command is unimplemented.

strlen

Long strlen(String key)
     throws WrongTypeException,
            NotImplementedException

Return the length of the string at key.

Parameters:

key - The key

Returns:

The length of the string

Throws:

WrongTypeException - If key is not a string

NotImplementedException - If the command is unimplemented.