com.mapbox.api.directions.v5.models

Class Admin

java.lang.Object

com.mapbox.api.directions.v5.models.DirectionsJsonObject

com.mapbox.api.directions.v5.models.Admin

All Implemented Interfaces:

java.io.Serializable

public abstract class Admin
extends DirectionsJsonObject

An objects describing the administrative boundaries the route leg travels through.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Admin()

Method Summary

Modifier and Type	Method and Description
static Admin.Builder	builder() Create a new instance of this class by using the Admin.Builder class.
abstract java.lang.String	countryCode() Contains the 2 character ISO 3166-1 alpha-2 code that applies to a country boundary.
abstract java.lang.String	countryCodeAlpha3() Contains the 3 character ISO 3166-1 alpha-3 code that applies to a country boundary.
static Admin	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract Admin.Builder	toBuilder() Convert the current Admin to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<Admin>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.

Methods inherited from class com.mapbox.api.directions.v5.models.DirectionsJsonObject

getUnrecognizedJsonProperties, getUnrecognizedPropertiesNames, getUnrecognizedProperty, toJson

Methods inherited from class java.lang.Object

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

Constructor Detail

Admin

public Admin()

Method Detail

countryCode

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

Contains the 2 character ISO 3166-1 alpha-2 code that applies to a country boundary. Example: `"US"`.

countryCodeAlpha3

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

Contains the 3 character ISO 3166-1 alpha-3 code that applies to a country boundary. Example: `"USA"`.

builder

public static Admin.Builder builder()

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

Returns:

this classes Admin.Builder for creating a new instance

toBuilder

public abstract Admin.Builder toBuilder()

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

Returns:

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

typeAdapter

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

fromJson

public static Admin fromJson(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 an Incident

Returns:

a new instance of this class defined by the values passed in the method