com.mapbox.api.geocoding.v6.models

Class V6Response

java.lang.Object

com.mapbox.api.geocoding.v6.models.V6Response

All Implemented Interfaces:

java.io.Serializable

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

This is the initial object which gets returned when the geocoding request receives a result.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
V6Response()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	attribution() Attributes the results of the Mapbox Geocoding API to Mapbox.
abstract java.util.List<V6Feature>	features() A list of feature objects.
static V6Response	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.String	type() "FeatureCollection", a GeoJSON type from the GeoJSON specification.
static com.google.gson.TypeAdapter<V6Response>	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

V6Response

public V6Response()

Method Detail

type

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

"FeatureCollection", a GeoJSON type from the GeoJSON specification.

Returns:

the type of GeoJSON

features

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

A list of feature objects. Forward geocodes: Returned features are ordered by relevance. Reverse geocodes: Returned features are ordered by index hierarchy, from most specific features to least specific features that overlap the queried coordinates.

Read the Search result prioritization guide to learn more about how returned features are organized in the Geocoding API response.

Returns:

a list of V6Features

attribution

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

Attributes the results of the Mapbox Geocoding API to Mapbox.

Returns:

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

fromJson

@NonNull
public static V6Response 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

typeAdapter

public static com.google.gson.TypeAdapter<V6Response> 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