org.springframework.data.redis.core.ReactiveListOperations Maven / Gradle / Ivy
/*
* Copyright 2017-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.redis.core;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import java.time.Duration;
import java.util.Collection;
import java.util.List;
/**
* Redis list specific operations.
*
* @author Mark Paluch
* @author Christoph Strobl
* @see Redis Documentation: List Commands
* @since 2.0
*/
public interface ReactiveListOperations {
/**
* Get elements between {@code begin} and {@code end} from list at {@code key}.
*
* @param key must not be {@literal null}.
* @param start
* @param end
* @return
* @see Redis Documentation: LRANGE
*/
Flux range(K key, long start, long end);
/**
* Trim list at {@code key} to elements between {@code start} and {@code end}.
*
* @param key must not be {@literal null}.
* @param start
* @param end
* @see Redis Documentation: LTRIM
*/
Mono trim(K key, long start, long end);
/**
* Get the size of list stored at {@code key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: LLEN
*/
Mono size(K key);
/**
* Prepend {@code value} to {@code key}.
*
* @param key must not be {@literal null}.
* @param value
* @return
* @see Redis Documentation: LPUSH
*/
Mono leftPush(K key, V value);
/**
* Prepend {@code values} to {@code key}.
*
* @param key must not be {@literal null}.
* @param values
* @return
* @see Redis Documentation: LPUSH
*/
Mono leftPushAll(K key, V... values);
/**
* Prepend {@code values} to {@code key}.
*
* @param key must not be {@literal null}.
* @param values must not be {@literal null}.
* @return
* @since 1.5
* @see Redis Documentation: LPUSH
*/
Mono leftPushAll(K key, Collection values);
/**
* Prepend {@code values} to {@code key} only if the list exists.
*
* @param key must not be {@literal null}.
* @param value
* @return
* @see Redis Documentation: LPUSHX
*/
Mono leftPushIfPresent(K key, V value);
/**
* Prepend {@code values} to {@code key} before {@code value}.
*
* @param key must not be {@literal null}.
* @param value
* @return
* @see Redis Documentation: LPUSH
*/
Mono leftPush(K key, V pivot, V value);
/**
* Append {@code value} to {@code key}.
*
* @param key must not be {@literal null}.
* @param value
* @return
* @see Redis Documentation: RPUSH
*/
Mono rightPush(K key, V value);
/**
* Append {@code values} to {@code key}.
*
* @param key must not be {@literal null}.
* @param values
* @return
* @see Redis Documentation: RPUSH
*/
Mono rightPushAll(K key, V... values);
/**
* Append {@code values} to {@code key}.
*
* @param key must not be {@literal null}.
* @param values
* @return
* @since 1.5
* @see Redis Documentation: RPUSH
*/
Mono rightPushAll(K key, Collection values);
/**
* Append {@code values} to {@code key} only if the list exists.
*
* @param key must not be {@literal null}.
* @param value
* @return
* @see Redis Documentation: RPUSHX
*/
Mono rightPushIfPresent(K key, V value);
/**
* Append {@code values} to {@code key} before {@code value}.
*
* @param key must not be {@literal null}.
* @param value
* @return
* @see Redis Documentation: RPUSH
*/
Mono rightPush(K key, V pivot, V value);
/**
* Set the {@code value} list element at {@code index}.
*
* @param key must not be {@literal null}.
* @param index
* @param value
* @see Redis Documentation: LSET
*/
Mono set(K key, long index, V value);
/**
* Removes the first {@code count} occurrences of {@code value} from the list stored at {@code key}.
*
* @param key must not be {@literal null}.
* @param count
* @param value
* @return
* @see Redis Documentation: LREM
*/
Mono remove(K key, long count, Object value);
/**
* Get element at {@code index} form list at {@code key}.
*
* @param key must not be {@literal null}.
* @param index
* @return
* @see Redis Documentation: LINDEX
*/
Mono index(K key, long index);
/**
* Removes and returns first element in list stored at {@code key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: LPOP
*/
Mono leftPop(K key);
/**
* Removes and returns first element from lists stored at {@code key}.
* Results return once an element available or {@code timeout} reached.
*
* @param key must not be {@literal null}.
* @param timeout maximal duration to wait until an entry in the list at {@code key} is available. Must be either
* {@link Duration#ZERO} or greater {@link 1 second}, must not be {@literal null}. A timeout of zero can be
* used to wait indefinitely. Durations between zero and one second are not supported.
* @return
* @see Redis Documentation: BLPOP
*/
Mono leftPop(K key, Duration timeout);
/**
* Removes and returns last element in list stored at {@code key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: RPOP
*/
Mono rightPop(K key);
/**
* Removes and returns last element from lists stored at {@code key}.
* Results return once an element available or {@code timeout} reached.
*
* @param key must not be {@literal null}.
* @param timeout maximal duration to wait until an entry in the list at {@code key} is available. Must be either
* {@link Duration#ZERO} or greater {@link 1 second}, must not be {@literal null}. A timeout of zero can be
* used to wait indefinitely. Durations between zero and one second are not supported.
* @return
* @see Redis Documentation: BRPOP
*/
Mono rightPop(K key, Duration timeout);
/**
* Remove the last element from list at {@code sourceKey}, append it to {@code destinationKey} and return its value.
*
* @param sourceKey must not be {@literal null}.
* @param destinationKey must not be {@literal null}.
* @return
* @see Redis Documentation: RPOPLPUSH
*/
Mono rightPopAndLeftPush(K sourceKey, K destinationKey);
/**
* Remove the last element from list at {@code srcKey}, append it to {@code dstKey} and return its value.
* Results return once an element available or {@code timeout} reached.
*
* @param sourceKey must not be {@literal null}.
* @param destinationKey must not be {@literal null}.
* @param timeout maximal duration to wait until an entry in the list at {@code sourceKey} is available. Must be
* either {@link Duration#ZERO} or greater {@link 1 second}, must not be {@literal null}. A timeout of zero
* can be used to wait indefinitely. Durations between zero and one second are not supported.
* @return
* @see Redis Documentation: BRPOPLPUSH
*/
Mono rightPopAndLeftPush(K sourceKey, K destinationKey, Duration timeout);
/**
* Removes the given {@literal key}.
*
* @param key must not be {@literal null}.
*/
Mono delete(K key);
}