K
- Key type.V
- Value type.public interface RedisListCommands<K,V>
Modifier and Type | Method and Description |
---|---|
KeyValue<K,V> |
blpop(long timeout,
K... keys)
Remove and get the first element in a list, or block until one is available.
|
KeyValue<K,V> |
brpop(long timeout,
K... keys)
Remove and get the last element in a list, or block until one is available.
|
V |
brpoplpush(long timeout,
K source,
K destination)
Pop a value from a list, push it to another list and return it; or block until one is available.
|
V |
lindex(K key,
long index)
Get an element from a list by its index.
|
Long |
linsert(K key,
boolean before,
V pivot,
V value)
Insert an element before or after another element in a list.
|
Long |
llen(K key)
Get the length of a list.
|
V |
lpop(K key)
Remove and get the first element in a list.
|
Long |
lpos(K key,
V value)
Return the index of matching elements inside a Redis list.
|
List<Long> |
lpos(K key,
V value,
int count)
Return the index of matching elements inside a Redis list using the
COUNT option. |
List<Long> |
lpos(K key,
V value,
int count,
LPosArgs args)
Return the index of matching elements inside a Redis list using the
COUNT option. |
Long |
lpos(K key,
V value,
LPosArgs args)
Return the index of matching elements inside a Redis list.
|
Long |
lpush(K key,
V... values)
Prepend one or multiple values to a list.
|
Long |
lpushx(K key,
V... values)
Prepend values to a list, only if the list exists.
|
List<V> |
lrange(K key,
long start,
long stop)
Get a range of elements from a list.
|
Long |
lrange(ValueStreamingChannel<V> channel,
K key,
long start,
long stop)
Get a range of elements from a list.
|
Long |
lrem(K key,
long count,
V value)
Remove elements from a list.
|
String |
lset(K key,
long index,
V value)
Set the value of an element in a list by its index.
|
String |
ltrim(K key,
long start,
long stop)
Trim a list to the specified range.
|
V |
rpop(K key)
Remove and get the last element in a list.
|
V |
rpoplpush(K source,
K destination)
Remove the last element in a list, append it to another list and return it.
|
Long |
rpush(K key,
V... values)
Append one or multiple values to a list.
|
Long |
rpushx(K key,
V... values)
Append values to a list, only if the list exists.
|
KeyValue<K,V> blpop(long timeout, K... keys)
timeout
- the timeout in seconds.keys
- the keys.null
multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with
the first element being the name of the key where an element was popped and the second element being the value of
the popped element.KeyValue<K,V> brpop(long timeout, K... keys)
timeout
- the timeout in seconds.keys
- the keys.null
multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with
the first element being the name of the key where an element was popped and the second element being the value of
the popped element.V brpoplpush(long timeout, K source, K destination)
timeout
- the timeout in seconds.source
- the source key.destination
- the destination type: key.source
and pushed to destination
. If
timeout
is reached, a.V lindex(K key, long index)
key
- the key.index
- the index type: long.null
when index
is out of range.Long linsert(K key, boolean before, V pivot, V value)
key
- the key.before
- the before.pivot
- the pivot.value
- the value.-1
when the value pivot
was not found.Long llen(K key)
key
- the key.key
.V lpop(K key)
key
- the key.null
when key
does not exist.Long lpos(K key, V value)
null
is returned. The returned elements indexes are
always referring to what lindex(java.lang.Object, long)
would return. So first element from head is 0
,
and so forth.key
- the key.value
- the element to search for.Long lpos(K key, V value, LPosArgs args)
null
is returned. The returned elements indexes are
always referring to what lindex(java.lang.Object, long)
would return. So first element from head is 0
,
and so forth.key
- the key.value
- the element to search for.args
- command arguments to configureFIRST
and MAXLEN
options.List<Long> lpos(K key, V value, int count)
COUNT
option. By default, when no options are
given, it will scan the list from head to tail, looking for the first match of "element". The returned elements indexes
are always referring to what lindex(java.lang.Object, long)
would return. So first element from head is
0
, and so forth.key
- the key.value
- the element to search for.count
- limit the number of matches.List<Long> lpos(K key, V value, int count, LPosArgs args)
COUNT
option. By default, when no options are
given, it will scan the list from head to tail, looking for the first match of "element". The returned elements indexes
are always referring to what lindex(java.lang.Object, long)
would return. So first element from head is
0
, and so forth.key
- the key.value
- the element to search for.count
- limit the number of matches.args
- command arguments to configureFIRST
and MAXLEN
options.Long lpush(K key, V... values)
key
- the key.values
- the value.Long lpushx(K key, V... values)
key
- the key.values
- the values.List<V> lrange(K key, long start, long stop)
key
- the key.start
- the start type: long.stop
- the stop type: long.Long lrange(ValueStreamingChannel<V> channel, K key, long start, long stop)
channel
- the channel.key
- the key.start
- the start type: long.stop
- the stop type: long.Long lrem(K key, long count, V value)
key
- the key.count
- the count type: long.value
- the value.String lset(K key, long index, V value)
key
- the key.index
- the index type: long.value
- the value.String ltrim(K key, long start, long stop)
key
- the key.start
- the start type: long.stop
- the stop type: long.V rpop(K key)
key
- the key.null
when key
does not exist.V rpoplpush(K source, K destination)
source
- the source key.destination
- the destination type: key.Long rpush(K key, V... values)
key
- the key.values
- the value.Copyright © 2020 lettuce.io. All rights reserved.