Most visited

Recently visited

Results for

Summary: Ctors | Methods | Inherited Methods

Geocoder

public final class Geocoder
extends Object

java.lang.Object
↳	android.location.Geocoder

A class for handling geocoding and reverse geocoding. Geocoding is the process of transforming a street address or other description of a location into a (latitude, longitude) coordinate. Reverse geocoding is the process of transforming a (latitude, longitude) coordinate into a (partial) address. The amount of detail in a reverse geocoded location description may vary, for example one might contain the full street address of the closest building, while another might contain only a city name and postal code. The Geocoder class requires a backend service that is not included in the core android framework. The Geocoder query methods will return an empty list if there no backend service in the platform. Use the isPresent() method to determine whether a Geocoder implementation exists.

Summary

Public constructors
`Geocoder(Context context, Locale locale)` Constructs a Geocoder whose responses will be localized for the given Locale.
`Geocoder(Context context)` Constructs a Geocoder whose responses will be localized for the default system Locale.

Public methods
`List<Address>`	`getFromLocation(double latitude, double longitude, int maxResults)` Returns an array of Addresses that are known to describe the area immediately surrounding the given latitude and longitude.
`List<Address>`	`getFromLocationName(String locationName, int maxResults, double lowerLeftLatitude, double lowerLeftLongitude, double upperRightLatitude, double upperRightLongitude)` Returns an array of Addresses that are known to describe the named location, which may be a place name such as "Dalvik, Iceland", an address such as "1600 Amphitheatre Parkway, Mountain View, CA", an airport code such as "SFO", etc..
`List<Address>`	`getFromLocationName(String locationName, int maxResults)` Returns an array of Addresses that are known to describe the named location, which may be a place name such as "Dalvik, Iceland", an address such as "1600 Amphitheatre Parkway, Mountain View, CA", an airport code such as "SFO", etc..
`static boolean`	`isPresent()` Returns true if the Geocoder methods getFromLocation and getFromLocationName are implemented.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

Geocoder

public Geocoder (Context context, 
                Locale locale)

Constructs a Geocoder whose responses will be localized for the given Locale.

Parameters
`context`	`Context`: the Context of the calling Activity
`locale`	`Locale`: the desired Locale for the query results

Throws
`NullPointerException`	if Locale is null

Geocoder

public Geocoder (Context context)

Constructs a Geocoder whose responses will be localized for the default system Locale.

Parameters
`context`	`Context`: the Context of the calling Activity

Public methods

getFromLocation

public List<Address> getFromLocation (double latitude, 
                double longitude, 
                int maxResults)

Returns an array of Addresses that are known to describe the area immediately surrounding the given latitude and longitude. The returned addresses will be localized for the locale provided to this class's constructor.

The returned values may be obtained by means of a network lookup. The results are a best guess and are not guaranteed to be meaningful or correct. It may be useful to call this method from a thread separate from your primary UI thread.

Parameters
`latitude`	`double`: the latitude a point for the search
`longitude`	`double`: the longitude a point for the search
`maxResults`	`int`: max number of addresses to return. Smaller numbers (1 to 5) are recommended

Returns
`List<Address>`	a list of Address objects. Returns null or empty list if no matches were found or there is no backend service available.

Throws
`IllegalArgumentException`	if latitude is less than -90 or greater than 90
`IllegalArgumentException`	if longitude is less than -180 or greater than 180
`IOException`	if the network is unavailable or any other I/O problem occurs

getFromLocationName

public List<Address> getFromLocationName (String locationName, 
                int maxResults, 
                double lowerLeftLatitude, 
                double lowerLeftLongitude, 
                double upperRightLatitude, 
                double upperRightLongitude)

Returns an array of Addresses that are known to describe the named location, which may be a place name such as "Dalvik, Iceland", an address such as "1600 Amphitheatre Parkway, Mountain View, CA", an airport code such as "SFO", etc.. The returned addresses will be localized for the locale provided to this class's constructor.

You may specify a bounding box for the search results by including the Latitude and Longitude of the Lower Left point and Upper Right point of the box.

The query will block and returned values will be obtained by means of a network lookup. The results are a best guess and are not guaranteed to be meaningful or correct. It may be useful to call this method from a thread separate from your primary UI thread.

Parameters
`locationName`	`String`: a user-supplied description of a location
`maxResults`	`int`: max number of addresses to return. Smaller numbers (1 to 5) are recommended
`lowerLeftLatitude`	`double`: the latitude of the lower left corner of the bounding box
`lowerLeftLongitude`	`double`: the longitude of the lower left corner of the bounding box
`upperRightLatitude`	`double`: the latitude of the upper right corner of the bounding box
`upperRightLongitude`	`double`: the longitude of the upper right corner of the bounding box

Returns
`List<Address>`	a list of Address objects. Returns null or empty list if no matches were found or there is no backend service available.

Throws
`IllegalArgumentException`	if locationName is null
`IllegalArgumentException`	if any latitude is less than -90 or greater than 90
`IllegalArgumentException`	if any longitude is less than -180 or greater than 180
`IOException`	if the network is unavailable or any other I/O problem occurs

getFromLocationName

public List<Address> getFromLocationName (String locationName, 
                int maxResults)

Parameters
`locationName`	`String`: a user-supplied description of a location
`maxResults`	`int`: max number of results to return. Smaller numbers (1 to 5) are recommended

Returns
`List<Address>`	a list of Address objects. Returns null or empty list if no matches were found or there is no backend service available.

Throws
`IllegalArgumentException`	if locationName is null
`IOException`	if the network is unavailable or any other I/O problem occurs

isPresent

public static boolean isPresent ()

Returns true if the Geocoder methods getFromLocation and getFromLocationName are implemented. Lack of network connectivity may still cause these methods to return null or empty lists.

Returns
`boolean`

Interfaces

Classes

Most visited

Recently visited

Results for

Geocoder

Summary

Public constructors

Public methods

Inherited methods

Public constructors

Geocoder

Geocoder

Public methods

getFromLocation

getFromLocationName

getFromLocationName

isPresent