org.redisson.api.RSortable 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.Collection;
import java.util.List;

/**
 * 
 * @author Nikita Koksharov
 *
 * @param  object type
 */
public interface RSortable extends RSortableAsync {

    /**
     * Read data in sorted view
     * 
     * @param order for sorted data
     * @return sorted collection
     */
    V readSort(SortOrder order);
    
    /**
     * Read data in sorted view
     * 
     * @param order for sorted data
     * @param offset of sorted data
     * @param count of sorted data
     * @return sorted collection
     */
    V readSort(SortOrder order, int offset, int count);

    /**
     * Read data in sorted view
     * 
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param order for sorted data
     * @return sorted collection
     */
    V readSort(String byPattern, SortOrder order);

    /**
     * Read data in sorted view
     * 
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param order for sorted data
     * @param offset of sorted data
     * @param count of sorted data
     * @return sorted collection
     */
    V readSort(String byPattern, SortOrder order, int offset, int count);

    /**
     * Read data in sorted view
     *
     * @param  object type
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param getPatterns that is used to load values by keys in sorted view
     * @param order for sorted data
     * @return sorted collection
     */
     Collection readSort(String byPattern, List getPatterns, SortOrder order);

    /**
     * Read data in sorted view
     * 
     * @param  object type
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param getPatterns that is used to load values by keys in sorted view
     * @param order for sorted data
     * @param offset of sorted data
     * @param count of sorted data
     * @return sorted collection
     */
     Collection readSort(String byPattern, List getPatterns, SortOrder order, int offset, int count);

    /**
     * Read data in sorted view lexicographically
     *
     * @param order for sorted data
     * @return sorted collection lexicographically
     */
    V readSortAlpha(SortOrder order);

    /**
     * Read data in sorted view lexicographically
     *
     * @param order for sorted data
     * @param offset of sorted data
     * @param count of sorted data
     * @return sorted collection lexicographically
     */
    V readSortAlpha(SortOrder order, int offset, int count);

    /**
     * Read data in sorted view lexicographically
     *
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param order for sorted data
     * @return sorted collection lexicographically
     */
    V readSortAlpha(String byPattern, SortOrder order);

    /**
     * Read data in sorted view lexicographically
     *
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param order for sorted data
     * @param offset of sorted data
     * @param count of sorted data
     * @return sorted collection lexicographically
     */
    V readSortAlpha(String byPattern, SortOrder order, int offset, int count);

    /**
     * Read data in sorted view lexicographically
     *
     * @param  object type
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param getPatterns that is used to load values by keys in sorted view
     * @param order for sorted data
     * @return sorted collection lexicographically
     */
     Collection readSortAlpha(String byPattern, List getPatterns, SortOrder order);

    /**
     * Read data in sorted view lexicographically
     *
     * @param  object type
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param getPatterns that is used to load values by keys in sorted view
     * @param order for sorted data
     * @param offset of sorted data
     * @param count of sorted data
     * @return sorted collection lexicographically
     */
     Collection readSortAlpha(String byPattern, List getPatterns, SortOrder order, int offset, int count);

    /**
     * Sort data and store to destName list
     * 
     * @param destName list object destination 
     * @param order for sorted data
     * @return length of sorted data
     */
    int sortTo(String destName, SortOrder order);

    /**
     * Sort data and store to destName list
     * 
     * @param destName list object destination
     * @param order for sorted data
     * @param offset of sorted data
     * @param count of sorted data
     * @return length of sorted data
     */
    int sortTo(String destName, SortOrder order, int offset, int count);
    
    /**
     * Sort data and store to destName list
     * 
     * @param destName list object destination
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param order for sorted data
     * @return length of sorted data
     */
    int sortTo(String destName, String byPattern, SortOrder order);

    /**
     * Sort data and store to destName list
     * 
     * @param destName list object destination
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param order for sorted data
     * @param offset of sorted data
     * @param count of sorted data
     * @return length of sorted data
     */
    int sortTo(String destName, String byPattern, SortOrder order, int offset, int count);

    /**
     * Sort data and store to destName list
     * 
     * @param destName list object destination
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param getPatterns that is used to load values by keys in sorted view
     * @param order for sorted data
     * @return length of sorted data
     */
    int sortTo(String destName, String byPattern, List getPatterns, SortOrder order);

    /**
     * Sort data and store to destName list
     * 
     * @param destName list object destination
     * @param byPattern that is used to generate the keys that are used for sorting
     * @param getPatterns that is used to load values by keys in sorted view
     * @param order for sorted data
     * @param offset of sorted data
     * @param count of sorted data
     * @return length of sorted data
     */
    int sortTo(String destName, String byPattern, List getPatterns, SortOrder order, int offset, int count);
    
}