Package com.cercalia.sdk.model.geoment

Class GeomentPostalCodeOptions

java.lang.Object

com.cercalia.sdk.model.geoment.GeomentPostalCodeOptions

public final class GeomentPostalCodeOptions
extends Object

Options for fetching postal code geometry.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static @NotNull GeomentPostalCodeOptions.Builder	builder(@NotNull String pcode)
@Nullable String	getCtryc()
@NotNull String	getPcode()
@Nullable Integer	getTolerance()
static @NotNull GeomentPostalCodeOptions	of(@NotNull String pcode)	Creates options for a postal code.
static @NotNull GeomentPostalCodeOptions	of(@NotNull String pcode, @NotNull String ctryc)	Creates options for a postal code with country code.
static @NotNull GeomentPostalCodeOptions	of(@NotNull String pcode, @NotNull String ctryc, int tolerance)	Creates options for a postal code with country code and tolerance.

Methods inherited from class java.lang.Object

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

Method Details

getPcode

@NotNull
public @NotNull String getPcode()

Returns:

postal code.

getCtryc

@Nullable
public @Nullable String getCtryc()

Returns:

country code.

getTolerance

@Nullable
public @Nullable Integer getTolerance()

Returns:

geometry simplification tolerance.

of

@NotNull
public static @NotNull GeomentPostalCodeOptions of(@NotNull
 @NotNull String pcode)

Creates options for a postal code.

Parameters:

pcode - postal code.

Returns:

a new GeomentPostalCodeOptions instance.

of

@NotNull
public static @NotNull GeomentPostalCodeOptions of(@NotNull
 @NotNull String pcode,
 @NotNull
 @NotNull String ctryc)

Creates options for a postal code with country code.

Parameters:

pcode - postal code.

ctryc - country code.

Returns:

a new GeomentPostalCodeOptions instance.

of

@NotNull
public static @NotNull GeomentPostalCodeOptions of(@NotNull
 @NotNull String pcode,
 @NotNull
 @NotNull String ctryc,
 int tolerance)

Creates options for a postal code with country code and tolerance.

Parameters:

pcode - postal code.

ctryc - country code.

tolerance - geometry simplification tolerance.

Returns:

a new GeomentPostalCodeOptions instance.

builder

@NotNull
public static @NotNull GeomentPostalCodeOptions.Builder builder(@NotNull
 @NotNull String pcode)

Parameters:

pcode - postal code.

Returns:

a new builder for GeomentPostalCodeOptions.