com.nbmap.api.geocoding.v5.models

Class GeocodingResponse

java.lang.Object

com.nbmap.api.geocoding.v5.models.GeocodingResponse

All Implemented Interfaces:

java.io.Serializable

public abstract class GeocodingResponse
extends java.lang.Object
implements java.io.Serializable

This is the initial object which gets returned when the geocoding request receives a result. Since each result is a CarmenFeature, the response simply returns a list of those features.

Since:

1.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeocodingResponse.Builder This builder can be used to set the values describing the GeocodingResponse.

Constructor Summary

Constructors

Constructor and Description
GeocodingResponse()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	attribution() A string attributing the results of the Nbmap Geocoding API to Nbmap and links to Nbmap's terms of service and data sources.
static GeocodingResponse.Builder	builder() Create a new instance of this class by using the GeocodingResponse.Builder class.
abstract java.util.List<CarmenFeature>	features() A list of the CarmenFeatures which contain the results and are ordered from most relevant to least.
static GeocodingResponse	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.util.List<java.lang.String>	query() A list of space and punctuation-separated strings from the original query.
abstract GeocodingResponse.Builder	toBuilder() Convert the current GeocodingResponse to its builder holding the currently assigned values.
java.lang.String	toJson() This takes the currently defined values found inside this instance and converts it to a GeoJson string.
abstract java.lang.String	type() A geocoding response will always be an extension of a FeatureCollection containing additional information.
static com.google.gson.TypeAdapter<GeocodingResponse>	typeAdapter(com.google.gson.Gson gson) Gson TYPE adapter for parsing Gson to this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeocodingResponse

public GeocodingResponse()

Method Detail

fromJson

@NonNull
public static GeocodingResponse fromJson(@NonNull
                                                  java.lang.String json)

Create a new instance of this class by passing in a formatted valid JSON String.

Parameters:

json - a formatted valid JSON string defining a GeoJson Geocoding Response

Returns:

a new instance of this class defined by the values passed inside this static factory method

Since:

3.0.0

builder

@NonNull
public static GeocodingResponse.Builder builder()

Create a new instance of this class by using the GeocodingResponse.Builder class.

Returns:

this classes GeocodingResponse.Builder for creating a new instance

Since:

3.0.0

type

@NonNull
public abstract java.lang.String type()

A geocoding response will always be an extension of a FeatureCollection containing additional information.

Returns:

the type of GeoJSON this is

Since:

1.0.0

query

@NonNull
public abstract java.util.List<java.lang.String> query()

A list of space and punctuation-separated strings from the original query.

Returns:

a list containing the original query

Since:

1.0.0

features

@NonNull
public abstract java.util.List<CarmenFeature> features()

A list of the CarmenFeatures which contain the results and are ordered from most relevant to least.

Returns:

a list of CarmenFeatures which each represent an individual result from the query

Since:

1.0.0

attribution

@NonNull
public abstract java.lang.String attribution()

A string attributing the results of the Nbmap Geocoding API to Nbmap and links to Nbmap's terms of service and data sources.

Returns:

information about Nbmap's terms of service and the data sources

Since:

1.0.0

toBuilder

@NonNull
public abstract GeocodingResponse.Builder toBuilder()

Convert the current GeocodingResponse to its builder holding the currently assigned values. This allows you to modify a single variable and then rebuild the object resulting in an updated and modified GeocodingResponse.

Returns:

a GeocodingResponse.Builder with the same values set to match the ones defined in this GeocodingResponse

Since:

3.0.0

toJson

@NonNull
public java.lang.String toJson()

This takes the currently defined values found inside this instance and converts it to a GeoJson string.

Returns:

a JSON string which represents this Geocoding Response

Since:

1.0.0

typeAdapter

public static com.google.gson.TypeAdapter<GeocodingResponse> typeAdapter(com.google.gson.Gson gson)

Gson TYPE adapter for parsing Gson to this class.

Parameters:

gson - the built Gson object

Returns:

the TYPE adapter for this class

Since:

3.0.0