ai.nextbillion.api.utils

Class FormatUtils

java.lang.Object

ai.nextbillion.api.utils.FormatUtils

public class FormatUtils
extends java.lang.Object

Methods to convert models to Strings.

Constructor Summary

Constructors

Constructor and Description
FormatUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	formatApproaches(java.util.List<java.lang.String> approaches) Converts String list with approaches values to a string ready for API consumption.
static java.lang.String	formatBearings(java.util.List<java.util.List<java.lang.Double>> bearings) Formats the bearing variables from the raw values to a string which can than be used for the request URL.
static java.lang.String	formatCoordinate(double coordinate) Useful to remove any trailing zeros and prevent a coordinate being over 7 significant figures.
static java.lang.String	formatCoordinates(java.util.List<ai.nextbillion.kits.geojson.Point> coordinates) Converts a list of Points to String.
static java.lang.String	formatDistributions(java.util.List<java.lang.Integer[]> distributions) Converts the list of integer arrays to a string ready for API consumption.
static java.lang.String	formatPointsList(java.util.List<ai.nextbillion.kits.geojson.Point> points) Converts array of Points with waypoint_targets values 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	formatWaypointNames(java.util.List<java.lang.String> waypointNames) Converts String list with waypoint_names values to a string ready for API consumption.
static java.lang.String	join(java.lang.CharSequence delimiter, java.util.List<?> tokens) Returns a string containing the tokens joined by delimiters.
static java.lang.String	join(java.lang.CharSequence delimiter, java.util.List<?> tokens, boolean removeTrailingNulls) 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

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. Doesn't remove trailing nulls.

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().

Returns:

String

join

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

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().

removeTrailingNulls - true if trailing nulls should be removed.

Returns:

String

formatCoordinate

@NonNull
public static java.lang.String formatCoordinate(double coordinate)

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

Parameters:

coordinate - a double value representing a coordinate.

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<java.util.List<java.lang.Double>> bearings)

Formats the bearing variables from the raw values to a string which can than be used for the request URL.

Parameters:

bearings - a List of list of doubles representing 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 integer arrays to a string ready for API consumption.

Parameters:

distributions - the list of integer arrays representing the distribution

Returns:

a string with the distribution values

formatApproaches

@Nullable
public static java.lang.String formatApproaches(@Nullable
                                                          java.util.List<java.lang.String> approaches)

Converts String list with approaches values to a string ready for API consumption. An approach could be unrestricted, curb or null.

Parameters:

approaches - a list representing approaches to each coordinate.

Returns:

a formatted string.

formatWaypointNames

@Nullable
public static java.lang.String formatWaypointNames(@Nullable
                                                             java.util.List<java.lang.String> waypointNames)

Converts String list with waypoint_names values to a string ready for API consumption.

Parameters:

waypointNames - a string representing approaches to each coordinate.

Returns:

a formatted string.

formatCoordinates

@Nullable
public static java.lang.String formatCoordinates(@NonNull
                                                           java.util.List<ai.nextbillion.kits.geojson.Point> coordinates)

Converts a list of Points to String.

Parameters:

coordinates - a list of coordinates.

Returns:

a formatted string.

formatPointsList

@Nullable
public static java.lang.String formatPointsList(@Nullable
                                                          java.util.List<ai.nextbillion.kits.geojson.Point> points)

Converts array of Points with waypoint_targets values to a string ready for API consumption.

Parameters:

points - a list representing approaches to each coordinate.

Returns:

a formatted string.