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

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

    /**
     * Defines search within box
     * 
     * Requires Redis 6.2.0 and higher.
     *
     * @param width - box width
     * @param height - box height
     * @param geoUnit - geo unit
     * @return search conditions object
     */
    OptionalGeoSearch box(double width, double height, GeoUnit geoUnit);

    /**
     * Defines search within radius
     *
     * @param radius - radius in geo units
     * @param geoUnit - geo unit
     * @return search conditions object
     */
    OptionalGeoSearch radius(double radius, GeoUnit geoUnit);

}