Package com.cercalia.sdk.model.poi

Class PoiNearestOptions

java.lang.Object

com.cercalia.sdk.model.poi.PoiNearestOptions

public final class PoiNearestOptions
extends Object

Options for searching nearest POIs by straight-line distance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PoiNearestOptions.Builder	Builder for PoiNearestOptions.

Method Summary

Modifier and Type	Method	Description
static @NotNull PoiNearestOptions.Builder	builder()
@NotNull List<String>	getCategories()
@Nullable Integer	getLimit()
@Nullable Integer	getRadius()
static @NotNull PoiNearestOptions	of(@NotNull String... categories)	Quick constructor for simple searches.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getCategories

@NotNull
public @NotNull List<String> getCategories()

Returns:

The list of POI category codes to search for.

getLimit

@Nullable
public @Nullable Integer getLimit()

Returns:

The maximum number of results to return.

getRadius

@Nullable
public @Nullable Integer getRadius()

Returns:

The search radius in meters.

builder

@NotNull
public static @NotNull PoiNearestOptions.Builder builder()

Returns:

A new builder instance.

of

@NotNull
public static @NotNull PoiNearestOptions of(@NotNull
 @NotNull String... categories)

Quick constructor for simple searches.

Parameters:

categories - The POI category codes to search for.

Returns:

A new PoiNearestOptions instance.