com.mapbox.api.directions.v5.utils

Class FormatUtils

java.lang.Object

com.mapbox.api.directions.v5.utils.FormatUtils

public class FormatUtils
extends java.lang.Object

Methods to convert models to Strings.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ISO_8601_PATTERN Date-time ISO-8601 pattern.

Constructor Summary

Constructors

Constructor and Description
FormatUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	formatBearings(java.util.List<Bearing> bearings) Formats the bearing variables from the raw values to a string ready for API consumption.
static java.lang.String	formatDistributions(java.util.List<java.lang.Integer[]> distributions) Converts the list of distributions to a string ready for API consumption.
static java.lang.String	formatDouble(double value) Useful to remove any trailing zeros and prevent a double being over 7 significant figures.
static java.lang.String	formatIntegers(java.util.List<java.lang.Integer> integers) Converts list of integers to a string ready for API consumption.
static java.lang.String	formatPointsList(java.util.List<com.mapbox.geojson.Point> points) Converts list of points to a string ready for API consumption.
static java.lang.String	formatRadiuses(java.util.List<java.lang.Double> radiuses) Used in various APIs to format the user provided radiuses to a String matching the APIs format.
static java.lang.String	join(java.lang.CharSequence delimiter, java.util.List<?> tokens) Returns a string containing the tokens joined by delimiters.

Methods inherited from class java.lang.Object

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

Field Detail

ISO_8601_PATTERN

public static final java.lang.String ISO_8601_PATTERN

Date-time ISO-8601 pattern.

See Also:

Constant Field Values

Constructor Detail

FormatUtils

public FormatUtils()

Method Detail

join

@Nullable
public static java.lang.String join(@NonNull
                                              java.lang.CharSequence delimiter,
                                              @Nullable
                                              java.util.List<?> tokens)

Returns a string containing the tokens joined by delimiters.

Parameters:

delimiter - the delimiter on which to split.

tokens - A list of objects to be joined. Strings will be formed from the objects by calling object.toString(). If a token in a list is null, an empty string is appended in its place.

Returns:

String with joint values, empty string if the token list was empty, or null if the tokens list was null

formatDouble

@NonNull
public static java.lang.String formatDouble(double value)

Useful to remove any trailing zeros and prevent a double being over 7 significant figures.

Parameters:

value - a double value

Returns:

a formatted string.

formatRadiuses

@Nullable
public static java.lang.String formatRadiuses(@Nullable
                                                        java.util.List<java.lang.Double> radiuses)

Used in various APIs to format the user provided radiuses to a String matching the APIs format.

Parameters:

radiuses - a list of doubles represents the radius values

Returns:

a String ready for being passed into the Retrofit call

formatBearings

@Nullable
public static java.lang.String formatBearings(@Nullable
                                                        java.util.List<Bearing> bearings)

Formats the bearing variables from the raw values to a string ready for API consumption.

Parameters:

bearings - a List of Bearing values

Returns:

a string with the bearing values

formatDistributions

@Nullable
public static java.lang.String formatDistributions(@Nullable
                                                             java.util.List<java.lang.Integer[]> distributions)

Converts the list of distributions to a string ready for API consumption.

Parameters:

distributions - the list of integer arrays representing the distribution

Returns:

a string with the distribution values

formatPointsList

@Nullable
public static java.lang.String formatPointsList(@Nullable
                                                          java.util.List<com.mapbox.geojson.Point> points)

Converts list of points to a string ready for API consumption.

Parameters:

points - a list representing of points

Returns:

a formatted string with semicolon separated pairs of doubles

formatIntegers

@Nullable
public static java.lang.String formatIntegers(@Nullable
                                                        java.util.List<java.lang.Integer> integers)

Converts list of integers to a string ready for API consumption.

Parameters:

integers - a list of integers

Returns:

a formatted string with semicolon separated integers