org.springframework.data.redis.core.ListOperations Maven / Gradle / Ivy
/*
* Copyright 2011-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 java.util.Collection;
import java.util.List;
import java.util.concurrent.TimeUnit;
import org.springframework.lang.Nullable;
/**
* Redis list specific operations.
*
* @author Costin Leau
* @author David Liu
* @author Thomas Darimont
* @author Christoph Strobl
* @author Mark Paluch
*/
public interface ListOperations {
/**
* 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 {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: LRANGE
*/
@Nullable
List 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
*/
void trim(K key, long start, long end);
/**
* Get the size of list stored at {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: LLEN
*/
@Nullable
Long size(K key);
/**
* Prepend {@code value} to {@code key}.
*
* @param key must not be {@literal null}.
* @param value
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: LPUSH
*/
@Nullable
Long leftPush(K key, V value);
/**
* Prepend {@code values} to {@code key}.
*
* @param key must not be {@literal null}.
* @param values
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: LPUSH
*/
@Nullable
Long 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 {@literal null} when used in pipeline / transaction.
* @since 1.5
* @see Redis Documentation: LPUSH
*/
@Nullable
Long 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 {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: LPUSHX
*/
@Nullable
Long leftPushIfPresent(K key, V value);
/**
* Prepend {@code values} to {@code key} before {@code value}.
*
* @param key must not be {@literal null}.
* @param value
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: LPUSH
*/
@Nullable
Long leftPush(K key, V pivot, V value);
/**
* Append {@code value} to {@code key}.
*
* @param key must not be {@literal null}.
* @param value
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: RPUSH
*/
@Nullable
Long rightPush(K key, V value);
/**
* Append {@code values} to {@code key}.
*
* @param key must not be {@literal null}.
* @param values
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: RPUSH
*/
@Nullable
Long rightPushAll(K key, V... values);
/**
* Append {@code values} to {@code key}.
*
* @param key must not be {@literal null}.
* @param values
* @return {@literal null} when used in pipeline / transaction.
* @since 1.5
* @see Redis Documentation: RPUSH
*/
@Nullable
Long 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 {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: RPUSHX
*/
@Nullable
Long rightPushIfPresent(K key, V value);
/**
* Append {@code values} to {@code key} before {@code value}.
*
* @param key must not be {@literal null}.
* @param value
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: RPUSH
*/
@Nullable
Long 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
*/
void 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 {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: LREM
*/
@Nullable
Long 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 {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: LINDEX
*/
@Nullable
V index(K key, long index);
/**
* Removes and returns first element in list stored at {@code key}.
*
* @param key must not be {@literal null}.
* @return can be {@literal null}.
* @see Redis Documentation: LPOP
*/
@Nullable
V leftPop(K key);
/**
* Removes and returns first element from lists stored at {@code key} .
* Blocks connection until element available or {@code timeout} reached.
*
* @param key must not be {@literal null}.
* @param timeout
* @param unit must not be {@literal null}.
* @return can be {@literal null}.
* @see Redis Documentation: BLPOP
*/
@Nullable
V leftPop(K key, long timeout, TimeUnit unit);
/**
* Removes and returns last element in list stored at {@code key}.
*
* @param key must not be {@literal null}.
* @return can be {@literal null}.
* @see Redis Documentation: RPOP
*/
@Nullable
V rightPop(K key);
/**
* Removes and returns last element from lists stored at {@code key}.
* Blocks connection until element available or {@code timeout} reached.
*
* @param key must not be {@literal null}.
* @param timeout
* @param unit must not be {@literal null}.
* @return can be {@literal null}.
* @see Redis Documentation: BRPOP
*/
@Nullable
V rightPop(K key, long timeout, TimeUnit unit);
/**
* 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 can be {@literal null}.
* @see Redis Documentation: RPOPLPUSH
*/
@Nullable
V rightPopAndLeftPush(K sourceKey, K destinationKey);
/**
* Remove the last element from list at {@code srcKey}, append it to {@code dstKey} and return its value.
* Blocks connection until element available or {@code timeout} reached.
*
* @param sourceKey must not be {@literal null}.
* @param destinationKey must not be {@literal null}.
* @param timeout
* @param unit must not be {@literal null}.
* @return can be {@literal null}.
* @see Redis Documentation: BRPOPLPUSH
*/
@Nullable
V rightPopAndLeftPush(K sourceKey, K destinationKey, long timeout, TimeUnit unit);
RedisOperations getOperations();
}