com.mapbox.api.directions.v5.models

Class ShieldSpriteAttribute

java.lang.Object

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

com.mapbox.api.directions.v5.models.ShieldSpriteAttribute

All Implemented Interfaces:

java.io.Serializable

public abstract class ShieldSpriteAttribute
extends DirectionsJsonObject
implements java.io.Serializable

ShieldSpriteAttribute.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ShieldSpriteAttribute()

Method Summary

Modifier and Type	Method and Description
static ShieldSpriteAttribute.Builder	builder() Create a new instance of this class by using the ShieldSpriteAttribute.Builder class.
static ShieldSpriteAttribute	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.Integer	height() Shield sprite's height.
abstract java.lang.Integer	pixelRatio() Shield sprite's pixel ratio.
abstract java.util.List<java.lang.Double>	placeholder() Shield sprite's placeholder (optional).
abstract ShieldSpriteAttribute.Builder	toBuilder() Convert the current ShieldSpriteAttribute to its builder holding the currently assigned values.
java.lang.String	toJson() This takes the currently defined values found inside the ShieldSpriteAttribute instance and converts it to a ShieldSpriteAttribute string.
static com.google.gson.TypeAdapter<ShieldSpriteAttribute>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract java.lang.Boolean	visible() Shield sprite's visibility.
abstract java.lang.Integer	width() Shield sprite's width.
abstract java.lang.Integer	x() Shield sprite's x position.
abstract java.lang.Integer	y() Shield sprite's y position.

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

getUnrecognizedJsonProperties, getUnrecognizedPropertiesNames, getUnrecognizedProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

ShieldSpriteAttribute

public ShieldSpriteAttribute()

Method Detail

builder

public static ShieldSpriteAttribute.Builder builder()

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

Returns:

ShieldSpriteAttribute.Builder for creating a new instance

fromJson

@NonNull
public static ShieldSpriteAttribute 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 shield sprite

Returns:

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

width

@NonNull
public abstract java.lang.Integer width()

Shield sprite's width.

height

@NonNull
public abstract java.lang.Integer height()

Shield sprite's height.

x

@NonNull
public abstract java.lang.Integer x()

Shield sprite's x position.

y

@NonNull
public abstract java.lang.Integer y()

Shield sprite's y position.

pixelRatio

@NonNull
public abstract java.lang.Integer pixelRatio()

Shield sprite's pixel ratio.

placeholder

@Nullable
public abstract java.util.List<java.lang.Double> placeholder()

Shield sprite's placeholder (optional).

visible

@NonNull
public abstract java.lang.Boolean visible()

Shield sprite's visibility.

toBuilder

public abstract ShieldSpriteAttribute.Builder toBuilder()

Convert the current ShieldSpriteAttribute 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 ShieldSpriteAttribute.

Returns:

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

toJson

@NonNull
public java.lang.String toJson()

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

Overrides:

toJson in class DirectionsJsonObject

Returns:

a JSON string which represents a ShieldSpriteAttribute

typeAdapter

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