StaticMarkerAnnotation.Builder (libjava-services 2.2.2 API)

java.lang.Object
- com.mapbox.services.api.staticimage.v1.models.StaticMarkerAnnotation.Builder

Enclosing class:

StaticMarkerAnnotation
```
public static class StaticMarkerAnnotation.Builder
extends java.lang.Object
```
Builder used for passing in custom parameters.

Since:

2.1.0

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StaticMarkerAnnotation`	`build()`
`java.lang.String`	`getColor()` A 3- or 6-digit hexadecimal color code represented as a String.
`java.lang.String`	`getLabel()` StaticMarkerAnnotation symbol.
`java.lang.Double`	`getLat()` Latitude for the center point of the static map.
`java.lang.Double`	`getLon()` Longitude for the center point of the static map.
`java.lang.String`	`getName()` The markers shape and size which can only be one of the three constants.
`com.mapbox.services.commons.models.Position`	`getPosition()` Get the markers latitude and longitude coordinate as a `Position` object.
`int`	`getPrecision()` The precision value being used for the coordinates.
`java.lang.String`	`getUrl()` The URL for the your custom marker icon.
`StaticMarkerAnnotation.Builder`	`setColor(java.lang.String color)` A 3- or 6-digit hexadecimal color code represented as a String.
`StaticMarkerAnnotation.Builder`	`setLabel(java.lang.String label)` StaticMarkerAnnotation symbol.
`StaticMarkerAnnotation.Builder`	`setLat(java.lang.Double lat)` Latitude for the center point of the static map.
`StaticMarkerAnnotation.Builder`	`setLon(java.lang.Double lon)` Longitude for the center point of the static map.
`StaticMarkerAnnotation.Builder`	`setName(java.lang.String name)` StaticMarkerAnnotation shape and size.
`StaticMarkerAnnotation.Builder`	`setPosition(com.mapbox.services.commons.models.Position position)` Optionally pass in a `Position` object containing the latitude and longitude coordinates you'd like your marker to be placed.
`StaticMarkerAnnotation.Builder`	`setPrecision(int precision)` In order to make the returned images better cacheable on the client, you can set the precision in decimals instead of manually rounding the parameters.
`StaticMarkerAnnotation.Builder`	`setUrl(java.lang.String url)` The URL for the your custom marker icon.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - getUrl
```
public java.lang.String getUrl()
```
    The URL for the your custom marker icon.
    
    Returns:
    
    A string with the Image address URL being used for your marker.
    
    Since:
    
    2.1.0
  - setUrl
```
public StaticMarkerAnnotation.Builder setUrl(java.lang.String url)
```
    The URL for the your custom marker icon. Can be of type PNG or JPG.
    
    Parameters:
    
    url - The direct url to your image that will be used for the marker icon.
    
    Returns:
    
    This StaticMarkerAnnotation builder.
    
    Since:
    
    2.1.0
  - getName
```
public java.lang.String getName()
```
    The markers shape and size which can only be one of the three constants.
    
    Returns:
    
    String containing the shape and size of the marker.
    
    Since:
    
    2.1.0
  - setName
```
public StaticMarkerAnnotation.Builder setName(java.lang.String name)
```
    StaticMarkerAnnotation shape and size. Options are Constants.PIN_SMALL, Constants.PIN_MEDIUM, or Constants.PIN_SMALL.
    
    Parameters:
    
    name - String containing the shape and size
    
    Returns:
    
    This StaticMarkerAnnotation builder
    
    Since:
    
    2.1.0
  - getLabel
```
public java.lang.String getLabel()
```
    StaticMarkerAnnotation symbol. Options are an alphanumeric label a through z, 0 through 99, or a valid Mapbox Maki icon. If a letter is requested, it will be rendered uppercase only.
    
    Returns:
    
    String containing the marker symbol.
    
    Since:
    
    2.1.0
  - setLabel
```
public StaticMarkerAnnotation.Builder setLabel(java.lang.String label)
```
    StaticMarkerAnnotation symbol. Options are an alphanumeric label a-A through z-Z, 0 through 99, or a valid Maki icon. If a letter is requested, it will be rendered uppercase only.
    
    Parameters:
    
    label - String containing the marker symbol.
    
    Returns:
    
    This StaticMarkerAnnotation builder.
    
    Since:
    
    2.1.0
  - getColor
```
public java.lang.String getColor()
```
    A 3- or 6-digit hexadecimal color code represented as a String. This defines the marker background color.
    
    Returns:
    
    String containing the color.
    
    Since:
    
    2.1.0
  - setColor
```
public StaticMarkerAnnotation.Builder setColor(java.lang.String color)
```
    A 3- or 6-digit hexadecimal color code represented as a String. If a non-valid color value's provided, a ServicesException will occur.
    
    Parameters:
    
    color - String containing the color.
    
    Returns:
    
    This StaticMarkerAnnotation builder.
    
    Since:
    
    2.1.0
  - getPosition
```
public com.mapbox.services.commons.models.Position getPosition()
```
    Get the markers latitude and longitude coordinate as a Position object.
    
    Returns:
    
    a Position object representing where the marker will be placed on the static image.
    
    Since:
    
    2.1.0
  - setPosition
```
public StaticMarkerAnnotation.Builder setPosition(com.mapbox.services.commons.models.Position position)
```
    Optionally pass in a Position object containing the latitude and longitude coordinates you'd like your marker to be placed.
    
    Parameters:
    
    position - A Position object.
    
    Returns:
    
    This StaticMarkerAnnotation builder.
    
    Since:
    
    2.1.0
  - getLat
```
public java.lang.Double getLat()
```
    Latitude for the center point of the static map.
    
    Returns:
    
    double number between -90 and 90.
    
    Since:
    
    2.1.0
  - setLat
```
public StaticMarkerAnnotation.Builder setLat(java.lang.Double lat)
```
    Latitude for the center point of the static map.
    
    Parameters:
    
    lat - double number between -90 and 90.
    
    Returns:
    
    This StaticMarkerAnnotation builder.
    
    Since:
    
    2.1.0
  - getLon
```
public java.lang.Double getLon()
```
    Longitude for the center point of the static map.
    
    Returns:
    
    double number between -180 and 180.
    
    Since:
    
    2.1.0
  - setLon
```
public StaticMarkerAnnotation.Builder setLon(java.lang.Double lon)
```
    Longitude for the center point of the static map.
    
    Parameters:
    
    lon - double number between -180 and 180.
    
    Returns:
    
    This StaticMarkerAnnotation builder.
    
    Since:
    
    2.1.0
  - setPrecision
```
public StaticMarkerAnnotation.Builder setPrecision(int precision)
```
    In order to make the returned images better cacheable on the client, you can set the precision in decimals instead of manually rounding the parameters.
    
    Parameters:
    
    precision - int number representing the precision for the formatter
    
    Returns:
    
    This StaticMarkerAnnotation builder.
    
    Since:
    
    2.1.0
  - getPrecision
```
public int getPrecision()
```
    The precision value being used for the coordinates.
    
    Returns:
    
    an integer value representing the precision being used.
    
    Since:
    
    2.1.0
  - build
```
public StaticMarkerAnnotation build()
                             throws ServicesException
```
    Throws:
    
    ServicesException

Class StaticMarkerAnnotation.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

getUrl

setUrl

getName

setName

getLabel

setLabel

getColor

setColor

getPosition

setPosition

getLat

setLat

getLon

setLon

setPrecision

getPrecision

build