org.redisson.api.RDequeAsync Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation
Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC
The newest version!
/**
 * Copyright (c) 2013-2024 Nikita Koksharov
 *
 * 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.redisson.api;

import org.redisson.api.queue.DequeMoveArgs;

import java.util.List;

/**
 * Distributed async implementation of {@link java.util.Deque}
 *
 * @author Nikita Koksharov
 *
 * @param  the type of elements held in this collection
 */
public interface RDequeAsync extends RQueueAsync {

    /**
     * Adds element at the head of existing deque.
     *
     * @param elements - elements to add
     * @return length of the list
     */
    RFuture addFirstIfExistsAsync(V... elements);

    /**
     * Adds elements at the head of deque.
     *
     * @param elements - elements to add
     * @return length of the deque
     */
    RFuture addFirstAsync(V... elements);

    /**
     * Adds element at the tail of existing deque.
     *
     * @param elements - elements to add
     * @return length of the list
     */
    RFuture addLastIfExistsAsync(V... elements);

    /**
     * Adds elements at the tail of deque.
     *
     * @param elements - elements to add
     * @return length of the deque
     */
    RFuture addLastAsync(V... elements);

    /**
     * Removes last occurrence of element o
     * 
     * @param o - element
     * @return true if object has been removed otherwise false
     */
    RFuture removeLastOccurrenceAsync(Object o);

    /**
     * Retrieves and removes the last element of deque.
     * Returns null if there are no elements in deque.
     * 
     * @return element
     */
    RFuture removeLastAsync();

    /**
     * Retrieves and removes the first element of deque.
     * Returns null if there are no elements in deque.
     * 
     * @return element
     */
    RFuture removeFirstAsync();

    /**
     * Removes first occurrence of element o
     * 
     * @param o - element to remove
     * @return true if object has been removed otherwise false
     */
    RFuture removeFirstOccurrenceAsync(Object o);

    /**
     * Adds element at the head of this deque.
     * 
     * @param e - element to add
     * @return void
     */
    RFuture pushAsync(V e);

    /**
     * Retrieves and removes element at the head of this deque.
     * Returns null if there are no elements in deque.
     * 
     * @return element
     */
    RFuture popAsync();

    /**
     * Retrieves and removes element at the tail of this deque.
     * Returns null if there are no elements in deque.
     * 
     * @return element
     */
    RFuture pollLastAsync();

    /**
     * Retrieves and removes element at the head of this deque.
     * Returns null if there are no elements in deque.
     * 
     * @return element
     */
    RFuture pollFirstAsync();

    /**
     * Returns element at the tail of this deque 
     * or null if there are no elements in deque.
     * 
     * @return element
     */
    RFuture peekLastAsync();

    /**
     * Returns element at the head of this deque 
     * or null if there are no elements in deque.
     * 
     * @return element
     */
    RFuture peekFirstAsync();

    /**
     * Adds element at the tail of this deque.
     * 
     * @param e - element to add
     * @return true if element was added to this deque otherwise false
     */
    RFuture offerLastAsync(V e);

    /**
     * Returns element at the tail of this deque 
     * or null if there are no elements in deque.
     * 
     * @return element
     */
    RFuture getLastAsync();

    /**
     * Adds element at the tail of this deque.
     * 
     * @param e - element to add
     * @return void
     */
    RFuture addLastAsync(V e);

    /**
     * Adds element at the head of this deque.
     * 
     * @param e - element to add
     * @return void
     */
    RFuture addFirstAsync(V e);

    /**
     * Adds element at the head of this deque.
     * 
     * @param e - element to add
     * @return true if element was added to this deque otherwise false
     */
    RFuture offerFirstAsync(V e);

    /**
     * Retrieves and removes the head elements of this queue.
     * Elements amount limited by limit param.
     *
     * @return list of head elements
     */
    RFuture> pollFirstAsync(int limit);

    /**
     * Retrieves and removes the tail elements of this queue.
     * Elements amount limited by limit param.
     *
     * @return list of tail elements
     */
    RFuture> pollLastAsync(int limit);

    /**
     * Move element from this deque to the given destination deque.
     * Returns moved element.
     * 
     * Usage examples:
     * 
     * V element = deque.move(DequeMoveArgs.pollLast()
     *                                 .addFirstTo("deque2"));
     * 
     *      * V elements = deque.move(DequeMoveArgs.pollFirst()
     *                                 .addLastTo("deque2"));
     * 
     * 
     * Requires Redis 6.2.0 and higher.
     *
     * @param args - arguments object
     * @return moved element
     */
    RFuture moveAsync(DequeMoveArgs args);

}