com.google.maps

Class GeoApiContext

java.lang.Object

com.google.maps.GeoApiContext

public class GeoApiContext
extends java.lang.Object

The entry point for making requests against the Google Geo APIs.

Construct this object by using the enclosed GeoApiContext.Builder.

GeoApiContexts should be shared

GeoApiContext works best when you create a single GeoApiContext instance, or one per API key, and reuse it for all your Google Geo API queries. This is because each GeoApiContext manages its own thread pool, back-end client, and other resources.

When you are finished with a GeoApiContext object, you must call shutdown() on it to release its resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoApiContext.Builder The Builder for GeoApiContext.
static interface	GeoApiContext.RequestHandler The service provider interface that enables requests to be handled via switchable back ends.

Method Summary

Modifier and Type	Method and Description
void	clearExperienceId() Clears the experience ID if set the HTTP header field HttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID will be omitted from subsequent calls.
java.lang.String	getExperienceId()
void	setExperienceId(java.lang.String... experienceId) Sets the value for the HTTP header field name HttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID to be used on subsequent API calls.
void	shutdown() Shut down this GeoApiContext instance, reclaiming resources.

Methods inherited from class java.lang.Object

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

Method Detail

setExperienceId

public void setExperienceId(java.lang.String... experienceId)

Sets the value for the HTTP header field name HttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID to be used on subsequent API calls. Calling this method with null is equivalent to calling clearExperienceId().

Parameters:

experienceId - The experience ID if set, otherwise null

getExperienceId

public java.lang.String getExperienceId()

Returns:

Returns the experience ID if set, otherwise, null

clearExperienceId

public void clearExperienceId()

Clears the experience ID if set the HTTP header field HttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID will be omitted from subsequent calls.

shutdown

public void shutdown()

Shut down this GeoApiContext instance, reclaiming resources. After shutdown() has been called, no further queries may be done against this instance.