org.springframework.data.redis.support.collections.RedisList Maven / Gradle / Ivy
/*
* Copyright 2011-2022 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
*
* https://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.support.collections;
import static org.springframework.data.redis.connection.RedisListCommands.*;
import java.time.Duration;
import java.util.Deque;
import java.util.List;
import java.util.Queue;
import java.util.concurrent.BlockingDeque;
import java.util.concurrent.TimeUnit;
import org.springframework.data.redis.core.BoundListOperations;
import org.springframework.data.redis.core.RedisOperations;
import org.springframework.data.redis.core.TimeoutUtils;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Redis extension for the {@link List} contract. Supports {@link List}, {@link Queue} and {@link Deque} contracts as
* well as their equivalent blocking siblings {@link BlockingDeque} and {@link BlockingDeque}.
*
* @author Costin Leau
* @author Mark Paluch
*/
public interface RedisList extends RedisCollection, List, BlockingDeque {
/**
* Constructs a new, uncapped {@link RedisList} instance.
*
* @param key Redis key of this list.
* @param operations {@link RedisOperations} for the value type of this list.
* @since 2.6
*/
static RedisList create(String key, RedisOperations operations) {
return new DefaultRedisList<>(key, operations);
}
/**
* Constructs a new {@link RedisList} instance.
*
* @param key Redis key of this list.
* @param operations {@link RedisOperations} for the value type of this list.
* @param maxSize
* @since 2.6
*/
static RedisList create(String key, RedisOperations operations, int maxSize) {
return new DefaultRedisList<>(key, operations, maxSize);
}
/**
* Constructs a new, uncapped {@link DefaultRedisList} instance.
*
* @param boundOps {@link BoundListOperations} for the value type of this list.
* @since 2.6
*/
static RedisList create(BoundListOperations boundOps) {
return new DefaultRedisList<>(boundOps);
}
/**
* Constructs a new {@link DefaultRedisList} instance.
*
* @param boundOps {@link BoundListOperations} for the value type of this list.
* @param maxSize
* @since 2.6
*/
static RedisList create(BoundListOperations boundOps, int maxSize) {
return new DefaultRedisList<>(boundOps, maxSize);
}
/**
* Atomically returns and removes the first element of the list stored at the bound key, and pushes the element at the
* first/last element (head/tail depending on the {@link Direction destinationPosition} argument) of the list stored
* at {@link RedisList destination}.
*
* @param destination must not be {@literal null}.
* @param destinationPosition must not be {@literal null}.
* @return
* @since 2.6
* @see Direction#first()
* @see Direction#last()
*/
@Nullable
E moveFirstTo(RedisList destination, Direction destinationPosition);
/**
* Atomically returns and removes the first element of the list stored at the bound key, and pushes the element at the
* first/last element (head/tail depending on the {@link Direction destinationPosition} argument) of the list stored
* at {@link RedisList destination}.
*
* Blocks connection until element available or {@code timeout} reached.
*
* @param destination must not be {@literal null}.
* @param destinationPosition must not be {@literal null}.
* @param timeout must not be {@literal null} or negative.
* @return
* @since 2.6
* @see Direction#first()
* @see Direction#last()
*/
@Nullable
default E moveFirstTo(RedisList destination, Direction destinationPosition, Duration timeout) {
Assert.notNull(timeout, "Timeout must not be null");
Assert.isTrue(!timeout.isNegative(), "Timeout must not be negative");
return moveFirstTo(destination, destinationPosition,
TimeoutUtils.toMillis(timeout.toMillis(), TimeUnit.MILLISECONDS), TimeUnit.MILLISECONDS);
}
/**
* Atomically returns and removes the first element of the list stored at the bound key, and pushes the element at the
* first/last element (head/tail depending on the {@link Direction destinationPosition} argument) of the list stored
* at {@link RedisList destination}.
*
* Blocks connection until element available or {@code timeout} reached.
*
* @param destination must not be {@literal null}.
* @param destinationPosition must not be {@literal null}.
* @param timeout
* @param unit must not be {@literal null}.
* @return
* @since 2.6
* @see Direction#first()
* @see Direction#last()
*/
@Nullable
E moveFirstTo(RedisList destination, Direction destinationPosition, long timeout, TimeUnit unit);
/**
* Atomically returns and removes the last element of the list stored at the bound key, and pushes the element at the
* first/last element (head/tail depending on the {@link Direction destinationPosition} argument) of the list stored
* at {@link RedisList destination}.
*
* @param destination must not be {@literal null}.
* @param destinationPosition must not be {@literal null}.
* @return
* @since 2.6
* @see Direction#first()
* @see Direction#last()
*/
@Nullable
E moveLastTo(RedisList destination, Direction destinationPosition);
/**
* Atomically returns and removes the last element of the list stored at the bound key, and pushes the element at the
* first/last element (head/tail depending on the {@link Direction destinationPosition} argument) of the list stored
* at {@link RedisList destination}.
*
* Blocks connection until element available or {@code timeout} reached.
*
* @param destination must not be {@literal null}.
* @param destinationPosition must not be {@literal null}.
* @param timeout must not be {@literal null} or negative.
* @return
* @since 2.6
* @see Direction#first()
* @see Direction#last()
*/
@Nullable
default E moveLastTo(RedisList destination, Direction destinationPosition, Duration timeout) {
Assert.notNull(timeout, "Timeout must not be null");
Assert.isTrue(!timeout.isNegative(), "Timeout must not be negative");
return moveLastTo(destination, destinationPosition,
TimeoutUtils.toMillis(timeout.toMillis(), TimeUnit.MILLISECONDS), TimeUnit.MILLISECONDS);
}
/**
* Atomically returns and removes the last element of the list stored at the bound key, and pushes the element at the
* first/last element (head/tail depending on the {@link Direction destinationPosition} argument) of the list stored
* at {@link RedisList destination}.
*
* Blocks connection until element available or {@code timeout} reached.
*
* @param destination must not be {@literal null}.
* @param destinationPosition must not be {@literal null}.
* @param timeout
* @param unit must not be {@literal null}.
* @return
* @since 2.6
* @see Direction#first()
* @see Direction#last()
*/
@Nullable
E moveLastTo(RedisList destination, Direction destinationPosition, long timeout, TimeUnit unit);
/**
* Get elements between {@code start} and {@code end} from list at the bound key.
*
* @param start
* @param end
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: LRANGE
*/
List range(long start, long end);
/**
* Trim list at the bound key to elements between {@code start} and {@code end}.
*
* @param start
* @param end
* @see Redis Documentation: LTRIM
*/
RedisList trim(int start, int end);
/**
* Trim list at the bound key to elements between {@code start} and {@code end}.
*
* @param start
* @param end
* @since 2.6
* @see Redis Documentation: LTRIM
*/
RedisList trim(long start, long end);
}