com.google.maps

Class DistanceMatrixApiRequest

java.lang.Object

com.google.maps.DistanceMatrixApiRequest

All Implemented Interfaces:

PendingResult<DistanceMatrix>

public class DistanceMatrixApiRequest
extends java.lang.Object

A request to the Distance Matrix API.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.maps.PendingResult

PendingResult.Callback<T>

Constructor Summary

Constructors

Constructor and Description
DistanceMatrixApiRequest(GeoApiContext context)

Method Summary

Methods

Modifier and Type	Method and Description
DistanceMatrixApiRequest	arrivalTime(org.joda.time.ReadableInstant arrivalTime) Specifies the desired time of arrival for transit requests.
DistanceMatrixApiRequest	avoid(DirectionsApi.RouteRestriction restriction) Introduces restrictions to the route.
T	await() Performs the request synchronously.
T	awaitIgnoreError() Performs the request synchronously, ignoring exceptions while performing the request and errors returned by the server.
void	cancel() Attempt to cancel the request.
DistanceMatrixApiRequest	departureTime(org.joda.time.ReadableInstant departureTime) Specifies the desired time of departure.
DistanceMatrixApiRequest	destinations(LatLng... points) One or more latitude/longitude values to which to calculate distance and time.
DistanceMatrixApiRequest	destinations(java.lang.String... destinations) One or more addresses to which to calculate distance and time.
A	language(java.lang.String language) The language in which to return results.
DistanceMatrixApiRequest	mode(TravelMode mode) Specifies the mode of transport to use when calculating directions.
DistanceMatrixApiRequest	origins(LatLng... points) One or more latitude/longitude values from which to calculate distance and time.
DistanceMatrixApiRequest	origins(java.lang.String... origins) One or more addresses from which to calculate distance and time.
protected A	param(java.lang.String key, java.lang.String val)
protected A	param(java.lang.String key, com.google.maps.internal.StringJoin.UrlValue val)
protected java.util.Map<java.lang.String,java.lang.String>	params()
void	setCallback(PendingResult.Callback<T> callback) Performs the request asynchronously, calling onResult or onFailure after the request has been completed.
DistanceMatrixApiRequest	transitModes(TransitMode... transitModes) Specifies one or more preferred modes of transit.
DistanceMatrixApiRequest	transitRoutingPreference(TransitRoutingPreference pref) Specifies preferences for transit requests.
DistanceMatrixApiRequest	units(Unit unit) Specifies the unit system to use when expressing distance as text.
protected void	validateRequest()

Methods inherited from class java.lang.Object

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

Constructor Detail

DistanceMatrixApiRequest

public DistanceMatrixApiRequest(GeoApiContext context)

Method Detail

validateRequest

protected void validateRequest()

origins

public DistanceMatrixApiRequest origins(java.lang.String... origins)

One or more addresses from which to calculate distance and time. The service will geocode the string and convert it to a latitude/longitude coordinate to calculate directions.

Parameters:

origins - String to geocode and use as an origin point (e.g. "New York, NY")

origins

public DistanceMatrixApiRequest origins(LatLng... points)

One or more latitude/longitude values from which to calculate distance and time.

Parameters:

points - The origin points.

destinations

public DistanceMatrixApiRequest destinations(java.lang.String... destinations)

One or more addresses to which to calculate distance and time. The service will geocode the string and convert it to a latitude/longitude coordinate to calculate directions.

Parameters:

destinations - String to geocode and use as a destination point (e.g. "New Jersey, NY")

destinations

public DistanceMatrixApiRequest destinations(LatLng... points)

One or more latitude/longitude values to which to calculate distance and time.

Parameters:

points - The destination points.

mode

public DistanceMatrixApiRequest mode(TravelMode mode)

Specifies the mode of transport to use when calculating directions.

Note that Distance Matrix requests only support TravelMode.DRIVING, TravelMode.WALKING and TravelMode.BICYCLING.

Parameters:

mode - One of the travel modes supported by the Distance Matrix API.

avoid

public DistanceMatrixApiRequest avoid(DirectionsApi.RouteRestriction restriction)

Introduces restrictions to the route. Only one restriction can be specified.

Parameters:

restriction - One of DirectionsApi.RouteRestriction.TOLLS, DirectionsApi.RouteRestriction.FERRIES or DirectionsApi.RouteRestriction.HIGHWAYS.

units

public DistanceMatrixApiRequest units(Unit unit)

Specifies the unit system to use when expressing distance as text. Distance Matrix results contain text within distance fields to indicate the distance of the calculated route.

Parameters:

unit - One of Unit.METRIC, Unit.IMPERIAL.

See Also:

Unit systems in the Distance Matrix API

departureTime

public DistanceMatrixApiRequest departureTime(org.joda.time.ReadableInstant departureTime)

Specifies the desired time of departure.

The departure time may be specified in two cases:

• For requests where the travel mode is transit: You can optionally specify one of departure_time or arrival_time. If neither time is specified, the departure_time defaults to now (that is, the departure time defaults to the current time).
• For requests where the travel mode is driving: Google Maps API for Work customers can specify the departure_time to receive trip duration considering current traffic conditions. The departure_time must be set to within a few minutes of the current time.

Setting the parameter to null will remove it from the API request.

Parameters:

departureTime - The time of departure.

arrivalTime

public DistanceMatrixApiRequest arrivalTime(org.joda.time.ReadableInstant arrivalTime)

Specifies the desired time of arrival for transit requests. You can specify either departure_time or arrival_time, but not both.

transitModes

public DistanceMatrixApiRequest transitModes(TransitMode... transitModes)

Specifies one or more preferred modes of transit. This parameter may only be specified for requests where the mode is transit.

transitRoutingPreference

public DistanceMatrixApiRequest transitRoutingPreference(TransitRoutingPreference pref)

Specifies preferences for transit requests. Using this parameter, you can bias the options returned, rather than accepting the default best route chosen by the API.

setCallback

public final void setCallback(PendingResult.Callback<T> callback)

Description copied from interface: PendingResult

Performs the request asynchronously, calling onResult or onFailure after the request has been completed.

Specified by:

setCallback in interface PendingResult<T>

await

public final T await()
              throws java.lang.Exception

Description copied from interface: PendingResult

Performs the request synchronously.

Specified by:

await in interface PendingResult<T>

Returns:

The result.

Throws:

java.lang.Exception

awaitIgnoreError

public final T awaitIgnoreError()

Description copied from interface: PendingResult

Performs the request synchronously, ignoring exceptions while performing the request and errors returned by the server.

Specified by:

awaitIgnoreError in interface PendingResult<T>

Returns:

The result, or null if there was any error or exception ignored.

cancel

public final void cancel()

Description copied from interface: PendingResult

Attempt to cancel the request.

Specified by:

cancel in interface PendingResult<T>

param

protected A param(java.lang.String key,
      java.lang.String val)

param

protected A param(java.lang.String key,
      com.google.maps.internal.StringJoin.UrlValue val)

params

protected java.util.Map<java.lang.String,java.lang.String> params()

language

public final A language(java.lang.String language)

The language in which to return results. Note that we often update supported languages so this list may not be exhaustive.

Parameters:

language - The language code, e.g. "en-AU" or "es"

See Also:

List of supported domain languages