Package com.google.maps

Class PlaceAutocompleteRequest

java.lang.Object

com.google.maps.PlaceAutocompleteRequest

All Implemented Interfaces:

PendingResult<AutocompletePrediction[]>

public class PlaceAutocompleteRequest
extends java.lang.Object

A Place Autocomplete request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlaceAutocompleteRequest.Response
static class	PlaceAutocompleteRequest.SessionToken	SessionToken represents an Autocomplete session.

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

PendingResult.Callback<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PlaceAutocompleteRequest(GeoApiContext context)

Method Summary

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.
PlaceAutocompleteRequest	components(ComponentFilter... filters)	A grouping of places to which you would like to restrict your results.
A	custom(java.lang.String parameter, java.lang.String value)	Custom parameter.
PlaceAutocompleteRequest	input(java.lang.String input)	Sets the text string on which to search.
A	language(java.lang.String language)	The language in which to return results.
PlaceAutocompleteRequest	location(LatLng location)	The point around which you wish to retrieve place information.
PlaceAutocompleteRequest	offset(int offset)	The character position in the input term at which the service uses text for predictions.
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()
PlaceAutocompleteRequest	radius(int radius)	The distance (in meters) within which to return place results.
PlaceAutocompleteRequest	sessionToken(PlaceAutocompleteRequest.SessionToken sessionToken)	Sets the SessionToken for this request.
void	setCallback(PendingResult.Callback<T> callback)	Performs the request asynchronously, calling onResult or onFailure after the request has been completed.
PlaceAutocompleteRequest	strictBounds(boolean strictBounds)	StrictBounds returns only those places that are strictly within the region defined by location and radius.
PlaceAutocompleteRequest	type(PlaceAutocompleteType type)	Deprecated. Please use types instead.
PlaceAutocompleteRequest	types(PlaceAutocompleteType types)	Restricts the results to places matching the specified type.
protected void	validateRequest()

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceAutocompleteRequest

protected PlaceAutocompleteRequest(GeoApiContext context)

Method Detail

sessionToken

public PlaceAutocompleteRequest sessionToken(PlaceAutocompleteRequest.SessionToken sessionToken)

Sets the SessionToken for this request. Using session token makes sure the autocomplete is priced per session, instead of per keystroke.

Parameters:

sessionToken - Session Token is the session identifier.

Returns:

Returns this PlaceAutocompleteRequest for call chaining.

input

public PlaceAutocompleteRequest input(java.lang.String input)

Sets the text string on which to search. The Places service will return candidate matches based on this string and order results based on their perceived relevance.

Parameters:

input - The input text to autocomplete.

Returns:

Returns this PlaceAutocompleteRequest for call chaining.

offset

public PlaceAutocompleteRequest offset(int offset)

The character position in the input term at which the service uses text for predictions. For example, if the input is 'Googl' and the completion point is 3, the service will match on 'Goo'. The offset should generally be set to the position of the text caret. If no offset is supplied, the service will use the entire term.

Parameters:

offset - The character offset position of the user's cursor.

Returns:

Returns this PlaceAutocompleteRequest for call chaining.

location

public PlaceAutocompleteRequest location(LatLng location)

The point around which you wish to retrieve place information.

Parameters:

location - The LatLng location to center this autocomplete search.

Returns:

Returns this PlaceAutocompleteRequest for call chaining.

radius

public PlaceAutocompleteRequest radius(int radius)

The distance (in meters) within which to return place results. Note that setting a radius biases results to the indicated area, but may not fully restrict results to the specified area.

Parameters:

radius - The radius over which to bias results.

Returns:

Returns this PlaceAutocompleteRequest for call chaining.

type

public PlaceAutocompleteRequest type(PlaceAutocompleteType type)

Deprecated.

Please use types instead.

Restricts the results to places matching the specified type.

Parameters:

type - The type to restrict results to.

Returns:

Returns this PlaceAutocompleteRequest for call chaining.

types

public PlaceAutocompleteRequest types(PlaceAutocompleteType types)

Restricts the results to places matching the specified type.

Parameters:

types - The type to restrict results to.

Returns:

Returns this PlaceAutocompleteRequest for call chaining.

components

public PlaceAutocompleteRequest components(ComponentFilter... filters)

A grouping of places to which you would like to restrict your results. Currently, you can use components to filter by country.

Parameters:

filters - The component filter to restrict results with.

Returns:

Returns this PlaceAutocompleteRequest for call chaining.

strictBounds

public PlaceAutocompleteRequest strictBounds(boolean strictBounds)

StrictBounds returns only those places that are strictly within the region defined by location and radius. This is a restriction, rather than a bias, meaning that results outside this region will not be returned even if they match the user input.

Parameters:

strictBounds - Whether to strictly bound results.

Returns:

Returns this PlaceAutocompleteRequest for call chaining.

validateRequest

protected void validateRequest()

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>

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 interface PendingResult<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 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

Attempts 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,
                  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.