com.google.maps

Class GeocodingApiRequest

java.lang.Object

com.google.maps.GeocodingApiRequest

All Implemented Interfaces:

PendingResult<GeocodingResult[]>

public class GeocodingApiRequest
extends java.lang.Object

Request for the Geocoding API.

Nested Class Summary

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

PendingResult.Callback<T>

Constructor Summary

Constructors

Constructor and Description
GeocodingApiRequest(GeoApiContext context)

Method Summary

Modifier and Type	Method and Description
GeocodingApiRequest	address(java.lang.String address) Create a forward geocode for address.
T	await() Performs the GET request synchronously.
T	awaitIgnoreError() Performs the request synchronously, ignoring exceptions while performing the request and errors returned by the server.
GeocodingApiRequest	bounds(LatLng southWestBound, LatLng northEastBound) Set the bounding box of the viewport within which to bias geocode results more prominently.
void	cancel() Attempt to cancel the request.
A	channel(java.lang.String channel) A channel to pass with the request.
GeocodingApiRequest	components(ComponentFilter... filters) Set the component filters.
A	custom(java.lang.String parameter, java.lang.String value) Custom parameter.
A	language(java.lang.String language) The language in which to return results.
GeocodingApiRequest	latlng(LatLng latlng) Create a reverse geocode for latlng.
GeocodingApiRequest	locationType(LocationType... locationTypes) Set the location type.
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()
GeocodingApiRequest	place(java.lang.String placeId) Create a forward geocode for placeId.
GeocodingApiRequest	region(java.lang.String region) Set the region code, specified as a ccTLD ("top-level domain") two-character value.
GeocodingApiRequest	resultType(AddressType... resultTypes) Set the result type.
void	setCallback(PendingResult.Callback<T> callback) Performs the request asynchronously, calling onResult or onFailure after the request has been completed.
protected void	validateRequest()

Methods inherited from class java.lang.Object

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

Constructor Detail

GeocodingApiRequest

public GeocodingApiRequest(GeoApiContext context)

Method Detail

validateRequest

protected void validateRequest()

address

public GeocodingApiRequest address(java.lang.String address)

Create a forward geocode for address.

place

public GeocodingApiRequest place(java.lang.String placeId)

Create a forward geocode for placeId.

latlng

public GeocodingApiRequest latlng(LatLng latlng)

Create a reverse geocode for latlng.

bounds

public GeocodingApiRequest bounds(LatLng southWestBound,
                                  LatLng northEastBound)

Set the bounding box of the viewport within which to bias geocode results more prominently. This parameter will only influence, not fully restrict, results from the geocoder. (

For more information see Viewports documentation.

region

public GeocodingApiRequest region(java.lang.String region)

Set the region code, specified as a ccTLD ("top-level domain") two-character value. This parameter will only influence, not fully restrict, results from the geocoder.

For more information see Region Codes.

components

public GeocodingApiRequest components(ComponentFilter... filters)

Set the component filters. Each component filter consists of a component:value pair and will fully restrict the results from the geocoder.

For more information see Component Filtering.

resultType

public GeocodingApiRequest resultType(AddressType... resultTypes)

Set the result type. Specifying a type will restrict the results to this type. If multiple types are specified, the API will return all addresses that match any of the types.

locationType

public GeocodingApiRequest locationType(LocationType... locationTypes)

Set the location type. Specifying a type will restrict the results to this type. If multiple types are specified, the API will return all addresses that match any of the types.

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 ApiException,
                     java.lang.InterruptedException,
                     java.io.IOException

Description copied from interface: PendingResult

Performs the GET request synchronously.

Specified by:

await in interface PendingResult<T>

Returns:

The result.

Throws:

ApiException

java.lang.InterruptedException

java.io.IOException

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

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: https://developers.google.com/maps/documentation/business/clientside/quota

Parameters:

channel - String to pass with the request for analytics

custom

public A custom(java.lang.String parameter,
                java.lang.String value)

Custom parameter. For advanced usage only. Note: Using this escape hatch parameter pass though voids all warranties, only use in extreme circumstances.