com.mapbox.api.geocoding.v6.models

Class V6Properties

java.lang.Object

com.mapbox.api.geocoding.v6.models.V6JsonObject

com.mapbox.api.geocoding.v6.models.V6Properties

All Implemented Interfaces:

java.io.Serializable

public abstract class V6Properties
extends V6JsonObject

A type which contains the majority of information returned by the Geocoding V6 API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
V6Properties()

Method Summary

Modifier and Type	Method and Description
abstract V6Context	context() An object representing the hierarchy of encompassing parent features.
abstract V6Coordinates	coordinates() Object containing coordinate parameters (lat, long), accuracy and routable points.
abstract java.lang.String	featureType() A string describing the type of the feature.
static V6Properties	fromJson(java.lang.String json) Create a V6Property object from JSON.
abstract java.lang.String	fullAddress() Full formatted string of the feature, combining name_preferred and place_formatted.
abstract java.lang.String	mapboxId() Feature id.
abstract V6MatchCode	matchCode() Additional metadata indicating how the result components match to the input query.
abstract java.lang.String	name() Formatted name.
abstract java.lang.String	namePreferred() The canonical or otherwise more common alias for the feature name.
abstract java.lang.String	placeFormatted() Formatted string of result context: place region country postcode.
static com.google.gson.TypeAdapter<V6Properties>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.

Methods inherited from class com.mapbox.api.geocoding.v6.models.V6JsonObject

getUnrecognizedJsonProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

V6Properties

public V6Properties()

Method Detail

mapboxId

@NonNull
 @SerializedName(value="mapbox_id")
public abstract java.lang.String mapboxId()

Feature id.

Returns:

feature id

featureType

@NonNull
 @SerializedName(value="feature_type")
public abstract java.lang.String featureType()

A string describing the type of the feature.

Returns:

a string describing the type of the feature

name

@Nullable
 @SerializedName(value="name")
public abstract java.lang.String name()

Formatted name.

Returns:

formatted name

namePreferred

@Nullable
 @SerializedName(value="name_preferred")
public abstract java.lang.String namePreferred()

The canonical or otherwise more common alias for the feature name. For example, searching for "America" will return "America" as the name, and "United States" as name_preferred.

Returns:

canonical or otherwise more common alias for the feature name

placeFormatted

@Nullable
 @SerializedName(value="place_formatted")
public abstract java.lang.String placeFormatted()

Formatted string of result context: place region country postcode. The part of the result which comes after name().

Returns:

formatted string of result context: place region country postcode

fullAddress

@Nullable
 @SerializedName(value="full_address")
public abstract java.lang.String fullAddress()

Full formatted string of the feature, combining name_preferred and place_formatted.

Returns:

full formatted string of the feature

context

@Nullable
 @SerializedName(value="context")
public abstract V6Context context()

An object representing the hierarchy of encompassing parent features. Addresses will also include an address context object, which contains the address street and address number properties broken out separately.

Returns:

an object representing the hierarchy of encompassing parent features

coordinates

@Nullable
 @SerializedName(value="coordinates")
public abstract V6Coordinates coordinates()

Object containing coordinate parameters (lat, long), accuracy and routable points.

Returns:

object containing coordinate parameters (lat, long) and accuracy

matchCode

@Nullable
 @SerializedName(value="match_code")
public abstract V6MatchCode matchCode()

Additional metadata indicating how the result components match to the input query.

Returns:

additional metadata indicating how the result components match to the input query

See Also:

Smart Address Match

fromJson

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

Create a V6Property object from JSON.

Parameters:

json - string of JSON making up a carmen context

Returns:

this class using the defined information in the provided JSON string

typeAdapter

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