org.redisson.api.geo.OptionalGeoSearch 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.geo;

import org.redisson.api.GeoOrder;

/**
 * Arguments object for RGeo search method.
 *
 * @author Nikita Koksharov
 */
public interface OptionalGeoSearch extends GeoSearchArgs {

    /**
     * Defines limit of search result
     *
     * @param value - result limit
     * @return search conditions object
     */
    OptionalGeoSearch count(int value);

    /**
     * Defines limit of search result.
     * Returns as soon as enough matches are found.
     * Result size might be not closest to defined limit,
     * but works faster.
     *
     * @param value - result limit
     * @return search conditions object
     */
    OptionalGeoSearch countAny(int value);

    /**
     * Defines order of search result
     *
     * @param geoOrder - result order
     * @return search conditions object
     */
    OptionalGeoSearch order(GeoOrder geoOrder);

}