com.mapbox.api.staticmap.v1.models

Class StaticMarkerAnnotation

java.lang.Object

com.mapbox.api.staticmap.v1.models.StaticMarkerAnnotation

public abstract class StaticMarkerAnnotation
extends java.lang.Object

Mapbox Static Image API marker overlay. Building this object allows you to place a marker on top or within your static image. The marker can either use the default marker (though you can change it's color and size) or you have the option to also pass in a custom marker icon using it's url.

Since:

2.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StaticMarkerAnnotation.Builder This builder is used to create a new request to the Mapbox Static Map API.

Constructor Summary

Constructors

Constructor and Description
StaticMarkerAnnotation()

Method Summary

Modifier and Type	Method and Description
static StaticMarkerAnnotation.Builder	builder() Build a new StaticMarkerAnnotation object with the initial values set for the name() to StaticMapCriteria.MEDIUM_PIN.
abstract StaticMarkerAnnotation.Builder	toBuilder() Convert the current StaticMarkerAnnotation to its builder holding the currently assigned values.
java.lang.String	url() Used Internally.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticMarkerAnnotation

public StaticMarkerAnnotation()

Method Detail

builder

public static StaticMarkerAnnotation.Builder builder()

Build a new StaticMarkerAnnotation object with the initial values set for the name() to StaticMapCriteria.MEDIUM_PIN.

Returns:

a StaticMarkerAnnotation.Builder object for creating this object

Since:

3.0.0

url

public java.lang.String url()

Used Internally.

Returns:

a String representing the marker part of the URL

Since:

2.1.0

toBuilder

public abstract StaticMarkerAnnotation.Builder toBuilder()

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

Returns:

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

Since:

3.1.0