com.mapbox.services.api.staticimage.v1.models

Class StaticPolylineAnnotation.Builder

java.lang.Object

com.mapbox.services.api.staticimage.v1.models.StaticPolylineAnnotation.Builder

Enclosing class:

StaticPolylineAnnotation

public static class StaticPolylineAnnotation.Builder
extends java.lang.Object

Builder used for passing in custom parameters.

Since:

2.1.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StaticPolylineAnnotation	build() Call to build a new instance of a StaticPolylineAnnotation object.
java.lang.String	getFillColor() Provides a String representing the hex code for the fill color.
java.lang.Float	getFillOpacity() If set, a number between 0 (transparent) and 1 (opaque) for the fill opacity.
java.lang.String	getPolyline() The current polyline string being used for the paths geometry.
java.lang.String	getStrokeColor() Provides a String representing the hex code for the line stroke.
java.lang.Float	getStrokeOpacity() A Float between 0 (transparent) and 1 (opaque) representing the lines opacity.
java.lang.Double	getStrokeWidth() Get the currently set stroke width for the line.
StaticPolylineAnnotation.Builder	setFillColor(java.lang.String fillColor) Optionally pass a 3- or 6-digit hexadecimal color code for the fill.
StaticPolylineAnnotation.Builder	setFillOpacity(float fillOpacity) Optionally pass a number between 0 (transparent) and 1 (opaque) for the fill opacity.
StaticPolylineAnnotation.Builder	setPolyline(java.lang.String polyline) A valid encoded polyline encoded as a URI component.
StaticPolylineAnnotation.Builder	setStrokeColor(java.lang.String strokeColor) A 3- or 6-digit hexadecimal color code for the line stroke.
StaticPolylineAnnotation.Builder	setStrokeOpacity(float strokeOpacity) A number between 0 (transparent) and 1 (opaque) for line stroke opacity.
StaticPolylineAnnotation.Builder	setStrokeWidth(double strokeWidth) Positive Double value for line stroke width.

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

getStrokeWidth

public java.lang.Double getStrokeWidth()

Get the currently set stroke width for the line.

Returns:

Positive Double value representing the stroke width.

Since:

2.1.0

setStrokeWidth

public StaticPolylineAnnotation.Builder setStrokeWidth(double strokeWidth)

Positive Double value for line stroke width. If a negative value is passed, a ServicesException will occur.

Parameters:

strokeWidth - A positive double value.

Returns:

This StaticPolylineAnnotation builder.

Since:

2.1.0

getStrokeColor

public java.lang.String getStrokeColor()

Provides a String representing the hex code for the line stroke.

Returns:

A 3- or 6-digit hexadecimal color code as a String.

Since:

2.1.0

setStrokeColor

public StaticPolylineAnnotation.Builder setStrokeColor(java.lang.String strokeColor)

A 3- or 6-digit hexadecimal color code for the line stroke. If a non-valid color's provided, a ServicesException will occur.

Parameters:

strokeColor - A string containing a 3 or 6 digit hexadecimal color code.

Returns:

This StaticPolylineAnnotation builder.

Since:

2.1.0

getStrokeOpacity

public java.lang.Float getStrokeOpacity()

A Float between 0 (transparent) and 1 (opaque) representing the lines opacity.

Returns:

a Float value between 0 and 1.

Since:

2.1.0

setStrokeOpacity

public StaticPolylineAnnotation.Builder setStrokeOpacity(float strokeOpacity)

A number between 0 (transparent) and 1 (opaque) for line stroke opacity. If a value out of range is provided, a ServicesException will occur.

Parameters:

strokeOpacity - a float value between 0 and 1 representing the lines opacity.

Returns:

This StaticPolylineAnnotation builder.

Since:

2.1.0

getFillColor

public java.lang.String getFillColor()

Provides a String representing the hex code for the fill color.

Returns:

a 3- or 6-digit hexadecimal color code for the fill.

Since:

2.1.0

setFillColor

public StaticPolylineAnnotation.Builder setFillColor(java.lang.String fillColor)

Optionally pass a 3- or 6-digit hexadecimal color code for the fill. If a non-valid color's provided, a ServicesException will occur.

Parameters:

fillColor - a string containing a 3 or 6 digit hexadecimal color code.

Returns:

This StaticPolylineAnnotation builder.

Since:

2.1.0

getFillOpacity

public java.lang.Float getFillOpacity()

If set, a number between 0 (transparent) and 1 (opaque) for the fill opacity.

Returns:

a float value between 0 and 1 representing the fills opacity.

Since:

2.1.0

setFillOpacity

public StaticPolylineAnnotation.Builder setFillOpacity(float fillOpacity)

Optionally pass a number between 0 (transparent) and 1 (opaque) for the fill opacity. If a value out of range is provided, a ServicesException will occur.

Parameters:

fillOpacity - a Float value between 0 and 1.

Returns:

This StaticPolylineAnnotation builder.

Since:

2.1.0

getPolyline

public java.lang.String getPolyline()

The current polyline string being used for the paths geometry. You can use PolylineUtils.decode(String, int) to decode the string using precision 5.

Returns:

A string which containing the paths geometry information.

Since:

2.1.0

setPolyline

public StaticPolylineAnnotation.Builder setPolyline(java.lang.String polyline)

A valid encoded polyline encoded as a URI component. This can be created using the PolylineUtils.encode(List, int) utility.

Parameters:

polyline - A string containing the paths geometry information.

Returns:

This StaticPolylineAnnotation buidler.

Since:

2.1.0

build

public StaticPolylineAnnotation build()
                               throws ServicesException

Call to build a new instance of a StaticPolylineAnnotation object.

Returns:

a polyline object ready for usage with the Static Image API.

Throws:

ServicesException - If any issues are recognized that could cause API errors.

Since:

2.1.0