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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of redisson Show documentation
Redis Java client with features of In-Memory Data Grid
There is a newer version: 3.40.2
/**
 * Copyright (c) 2013-2019 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 io.reactivex.Flowable;

/**
 * RxJava2 interface for Deque object
 *
 * @author Nikita Koksharov
 *
 * @param  the type of elements held in this collection
 */
public interface RDequeRx extends RQueueRx {

    Flowable descendingIterator();

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

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

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

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

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

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

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

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

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

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

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

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

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

    /**
     * Adds element at the head of this deque.
     * 
     * @param e - element to add
     * @return void
     */
    Flowable addFirst(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
     */
    Flowable offerFirst(V e);

}