org.redisson.api.RPriorityQueue 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

There is a newer version: 3.40.2

Show 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 java.util.Comparator;
import java.util.List;

/**
 * 
 * Redis based priority deque.
 * 
 * @author Nikita Koksharov
 *
 * @param  value type
 */
public interface RPriorityQueue extends RQueue, RObject {

    /**
     * Returns comparator used by this queue
     * 
     * @return comparator object
     */
    Comparator comparator();
    
    /**
     * Returns all queue elements at once
     * 
     * @return elements
     */
    List readAll();
    
    /**
     * Retrieves and removes last available tail element of this queue queue and adds it at the head of queueName.
     *
     * @param queueName - names of destination queue
     * @return the tail of this queue, or {@code null} if the
     *         specified waiting time elapses before an element is available
     */
    V pollLastAndOfferFirstTo(String queueName);
    
    /**
     * Sets new comparator only if current set is empty
     *
     * @param comparator for values
     * @return true if new comparator setted
     *         false otherwise
     */
    boolean trySetComparator(Comparator comparator);

}