Package com.google.maps
Class SnapToRoadsApiRequest
- java.lang.Object
-
- com.google.maps.SnapToRoadsApiRequest
-
- All Implemented Interfaces:
PendingResult<SnappedPoint[]>
public class SnapToRoadsApiRequest extends java.lang.Object
A request to the snap to roads API (part of Roads API).
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.google.maps.PendingResult
PendingResult.Callback<T>
-
-
Constructor Summary
Constructors Constructor Description SnapToRoadsApiRequest(GeoApiContext context)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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()
Attempts to cancel the request.A
channel(java.lang.String channel)
A channel to pass with the request.A
custom(java.lang.String parameter, java.lang.String value)
Custom parameter.A
experienceIds(java.lang.String... experienceIds)
Sets the value for the HTTP header field nameHttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID
.A
header(java.lang.String key, java.lang.String value)
Sets the header namedkey
tovalue
.SnapToRoadsApiRequest
interpolate(boolean interpolate)
Whether to interpolate a path to include all points forming the full road-geometry.A
language(java.lang.String language)
The language in which to return results.protected A
param(java.lang.String key, int val)
protected A
param(java.lang.String key, com.google.maps.internal.StringJoin.UrlValue val)
protected A
param(java.lang.String key, java.lang.String val)
protected A
paramAddToList(java.lang.String key, com.google.maps.internal.StringJoin.UrlValue val)
protected A
paramAddToList(java.lang.String key, java.lang.String val)
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>
params()
SnapToRoadsApiRequest
path(LatLng... path)
The path from which to snap to roads.void
setCallback(PendingResult.Callback<T> callback)
protected void
validateRequest()
-
-
-
Constructor Detail
-
SnapToRoadsApiRequest
public SnapToRoadsApiRequest(GeoApiContext context)
-
-
Method Detail
-
validateRequest
protected void validateRequest()
-
path
public SnapToRoadsApiRequest path(LatLng... path)
The path from which to snap to roads.- Parameters:
path
- the path to be snapped- Returns:
- returns this
SnapToRoadsApiRequest
for call chaining.
-
interpolate
public SnapToRoadsApiRequest interpolate(boolean interpolate)
Whether to interpolate a path to include all points forming the full road-geometry.- Parameters:
interpolate
- if the points should be interpolated or not- Returns:
- returns this
SnapToRoadsApiRequest
for call chaining.
-
setCallback
public final void setCallback(PendingResult.Callback<T> callback)
Description copied from interface:PendingResult
Performs the request asynchronously, callingonResult
oronFailure
after the request has been completed.- Specified by:
setCallback
in interfacePendingResult<T>
- Parameters:
callback
- The callback to call on completion.
-
await
public final T await() throws ApiException, java.lang.InterruptedException, java.io.IOException
Description copied from interface:PendingResult
Performs the request synchronously.- Specified by:
await
in interfacePendingResult<T>
- Returns:
- The result.
- Throws:
ApiException
- Thrown if the API Returned result is an error.java.lang.InterruptedException
- Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted.java.io.IOException
- Thrown when an I/O exception of some sort has occurred.
-
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 interfacePendingResult<T>
- Returns:
- The result, or null if there was any error or exception ignored.
-
cancel
public final void cancel()
Description copied from interface:PendingResult
Attempts to cancel the request.- Specified by:
cancel
in interfacePendingResult<T>
-
header
public A header(java.lang.String key, java.lang.String value)
Sets the header namedkey
tovalue
. If this request already has any headers with the same key, the value is replaced.- Parameters:
key
- the header keyvalue
- the header value- Returns:
- this request
-
experienceIds
public A experienceIds(java.lang.String... experienceIds)
Sets the value for the HTTP header field nameHttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID
. Passing null to this method will unset the experienceId header field.- Parameters:
experienceIds
- The experience IDs
-
param
protected A param(java.lang.String key, java.lang.String val)
-
param
protected A param(java.lang.String key, int val)
-
param
protected A param(java.lang.String key, com.google.maps.internal.StringJoin.UrlValue val)
-
paramAddToList
protected A paramAddToList(java.lang.String key, java.lang.String val)
-
paramAddToList
protected A paramAddToList(java.lang.String key, com.google.maps.internal.StringJoin.UrlValue val)
-
params
protected java.util.Map<java.lang.String,java.util.List<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".- Returns:
- Returns the request for call chaining.
- See Also:
- List of supported domain languages
-
channel
public A channel(java.lang.String channel)
A channel to pass with the request. channel is used by Google Maps API for Work users to be able to track usage across different applications with the same clientID. See Premium Plan Usage Rates and Limits.- Parameters:
channel
- String to pass with the request for analytics.- Returns:
- Returns the request for call chaining.
-
custom
public A custom(java.lang.String parameter, java.lang.String value)
Custom parameter. For advanced usage only.- Parameters:
parameter
- The name of the custom parameter.value
- The value of the custom parameter.- Returns:
- Returns the request for call chaining.
-
-